Jrockhub.ExportExcel.NETCore 1.0.0

Jrockhub Excel Export

You can easily generate Excel/CSV Report in ASP.NET Core or MVC.

To export/download the List<T> Or IEnumerable<T> data as an excel file, add action method in your controller as shown below. Return the data as ExcelResult<T>/CSVResult<T> by passing filtered/ordered data, sheet name and file name. ExcelResult/CSVResult Action Result that I have added in the Nuget package. This will take care of converting your data as excel/csv file and return it back to browser.

Note: Please see example for downloading/exporting excel/csv from Asp.Net Core 6.0 Backend.

Columns

Name

Column names in Excel Export can be configured using the below attributes

• [Display(Name = "")]
• [DisplayName(“”)]

Report Setup

To customize the Excel Column display in your report, use the following attribute

• [IncludeInReport]
• [NestedIncludeInReport]

And here are the options,

NuGet:

• Jrockhub.ExportExcel.NETCore v1.0.0

Package Manager:

PM> Install-Package Jrockhub.ExportExcel.NETCore

.NET CLI:

> dotnet add package Jrockhub.ExportExcel.NETCore

Main Model

public class ExportExcel
{
    public int Id { get; set; }

    [IncludeInReport(Order = 1)]
    public string Name { get; set; }

    [IncludeInReport(Order = 2)]
    public string Position { get; set; }

    [NestedIncludeInReport]
    public NestedLevelOne NestedLevelOne { get; set; }
}

Nested Level One Model:

public class NestedLevelOne
{
    [IncludeInReport(Order = 3)]
    public short? Experience { get; set; }

    [DisplayName("Extn")]
    [IncludeInReport(Order = 4)]
    public int? Extension { get; set; }

    [NestedIncludeInReport]
    public NestedLevelTwo NestedLevelTwos { get; set; }
}

Nested Level Two Model:

public class NestedLevelTwo
{
    [DisplayName("Start Date")]
    [IncludeInReport(Order = 5)]
    public DateTime? StartDates { get; set; }

    [IncludeInReport(Order = 6)]
    public long? Salary { get; set; }
}

Action Method

public async Task<IActionResult> GetExcel()
{
    // Get you IEnumerable<T> data
    var results = await _fromDatabaseService.GetDataAsync();
    return new ExcelResult<ExportExcel>(results, "Export Sheet Name", "Jrockhub_Guid");
}

public async Task<IActionResult> GetCSV()
{
    // Get you IEnumerable<T> data
    var results = await _fromDatabaseService.GetDataAsync();
    return new CSVResult<ExportExcel>(results, "Jrockhub_Guid");
}

Page Handler

public async Task<IActionResult> OnGetExcelAsync()
{
     // Get you IEnumerable<T> data
    var results = await _fromDatabaseService.GetDataAsync();
    return new ExcelResult<ExportExcel>(results, "Export Sheet Name", "Jrockhub_Guid");
}

public async Task<IActionResult> OnGetCSVAsync()
{
     // Get you IEnumerable<T> data
    var results = await _fromDatabaseService.GetDataAsync();
    return new CSVResult<ExportExcel>(results, "Jrockhub_Guid");
}

Target Platform

• .Net Standard 6.0

Tools Used

• Visual Studio Community 2022

Other Nuget Packages Used

• ClosedXML (0.97.0) - For Generating Excel Bytes
• Microsoft.AspNetCore.Mvc.Abstractions (2.2.0) - For using IActionResult
• NETStandard.Library (2.0.3) - For standard .NET APIs that are prescribed to be used and supported together
• System.ComponentModel.Annotations (5.0.0) - For Reading Column Names from Annotations

Author

• Jrockhub - Software Development.

Contributions

Feel free to submit a pull request if you can add additional functionality or find any bugs (to see a list of active issues), visit the Issues section. Please make sure all commits are properly documented.

License

Jrockhub ExportExcel NETCore is release under the MIT license. You are free to use, modify and distribute this software, as long as the copyright header is left intact.

Enjoy!

Sponsors

I'm happy to help you with my Nuget Package. Support this project, Please pay us on (https://www.paypalobjects.com/webstatic/mktg/Logo/pp-logo-100px.png)](https://paypal.me/jrockhub)