Goffo.ExcelExport 1.1.0

Excel Export

This uses the ClosedXML library. It allows for quick export of an IEnumerable of an generic class type to an excel file and is also able to do multiple sheets. Sheet names can be provided. Column headers can be specified using the DisplayName attribute from System.ComponentModel.

Code Examples

using ExcelExport.Services;
using System.ComponentModel;

//Create a new service
IExcelExportService _service = new ExcelExportService();

//Data Setup
List<PersonModel> PeopleList = new List<PersonModel>
{
    new PersonModel{ FirstName = "John", LastName = "Doe", Email = "johndoe@gmail.com" },
    new PersonModel{ FirstName = "Jane", LastName = "Doe", Email = "janedoe@gmail.com" },
};

List<AnimalModel> AnimalList = new List<AnimalModel>
{
    new AnimalModel{ CommonName = "Tiger", IsExtinct = false },
    new AnimalModel{ CommonName = "Dodo Bird", IsExtinct = true },
    new AnimalModel{ CommonName = "Zebra", IsExtinct = false }
};

//Define Sheet Names
string excelSheetName = "List of People";

//Single Sheet as Byte Array
byte[] ExcelBytes = await _service.ExcelExportAsByteArrayAsync(PeopleList, excelSheetName);

//Do something with your byte array...
Console.WriteLine(ExcelBytes.Length);

//Multiple Sheets as Byte Array
//Initialize and then Add 
_service.InitializeExcelDataSheets();
_service.AddExcelDataSheet(PeopleList, "List of People");
_service.AddExcelDataSheet(AnimalList, "List of Animals");
ExcelBytes = await _service.ExcelExportMultiSheetAsByteArrayAsync();

//Do something with your byte array...
Console.WriteLine(ExcelBytes.Length);


//Set File
string file = @$"C:\Users\{Environment.UserName}\MyExcelFile.xlsx";

//Single Sheet as File
await _service.ExcelExportAsFileAsync(PeopleList, file, excelSheetName);

Console.WriteLine("Excel file created: {0}", file);

//Multiple Sheets as File
file = @$"C:\Users\{Environment.UserName}\MyExcelMulitSheetFile.xlsx";

//Initialize and then Add 
_service.InitializeExcelDataSheets();
_service.AddExcelDataSheet(PeopleList, "List of People");
_service.AddExcelDataSheet(AnimalList, "List of Animals");

await _service.ExcelExportMultiSheetAsFileAsync(file);

Console.WriteLine("Excel file created: {0}", file);

internal class PersonModel
{
    //Column Header will use Display Name Attribute if set
    [DisplayName("First Name")]
    public string FirstName { get; set; } = string.Empty;

    [DisplayName("Last Name")]
    public string LastName { get; set; } = string.Empty;
    public string Email { get; set; } = string.Empty;

}

internal class AnimalModel
{
    [DisplayName("Common Name")]
    public string CommonName { get; set; } = string.Empty;

    [DisplayName("Extinct")]
    public bool IsExtinct { get; set; }
}