Csv Helper for Excel

This project has been forked from https://github.com/christophano/CsvHelper.Excel and heavily modified; primarily so that it can be used with the latest version of CsvHelper and uses EPPlus instead of ClosedXml.

NuGet packages of this fork are available from MyGet: https://www.myget.org/feed/lethek/package/nuget/CsvHelper.Excel

CsvHelper for Excel is an extension that links 2 excellent libraries, CsvHelper and EPPlus. It provides an implementation of IParser and ISerializer from CsvHelper that read and write to Excel using EPPlus.

ExcelParser

ExcelParser implements IParser and allows you to specify the path of the Excel package, pass an instance of ExcelPackage, ExcelWorkbook, ExcelWorksheet or ExcelRange that you have already loaded to use as the data source.

When the path is passed to the constructor then the workbook loading and disposal is handled by the parser. By default the first worksheet is used as the data source.

using (var reader = new CsvReader(new ExcelParser("path/to/file.xlsx")))
{
    var people = reader.GetRecords<Person>();
}

When an instance of ExcelPackage is passed to the constructor then disposal will not be handled by the parser. By default the first worksheet is used as the data source.

using (var package = new ExcelPackage("path/to/file.xlsx"))
{
    // do stuff with the package
    using (var reader = new CsvReader(new ExcelParser(package)))
    {
        var people = reader.GetRecords<Person>();
    }
    // do other stuff with workbook
}

When an instance of ExcelWorksheet is passed to the constructor then disposal will not be handled by the parser and the worksheet will be used as the data source.

using (var package = new ExcelPackage("path/to/file.xlsx"))
{
    var worksheet = package.Workbook.Worksheets.First(sheet => sheet.Name == "Folk");
    using (var reader = new CsvReader(new ExcelParser(worksheet)))
    {
        var people = reader.GetRecords<Person>();
    }
}

All constructor options have overloads allowing you to specify your own Configuration, otherwise the default is used.

ExcelSerializer

ExcelSerializer implements ISerializer and, like ExcelParser, allows you to specify the path to which to (eventually) save the workbook, pass an instance of ExcelPackage that you have already created, or pass a specific instance of ExcelWorksheet/ExcelRange to use as the destination.

When the path is passed to the constructor the creation and disposal of both the workbook and worksheet (named "Export" by default) as well as the saving of the workbook on dispose, is handled by the serialiser.

using (var writer = new CsvWriter(new ExcelSerializer("path/to/file.xlsx")))
{
    writer.WriteRecords(people);
}

When an instance of ExcelPackage is passed to the constructor, the creation and disposal of a new worksheet (named "Export" by default) is handled by the serialiser, but the workbook will not be saved automatically.

using (var package = new ExcelPackage())
{
    // do stuff with the package
    using (var writer = new CsvWriter(new ExcelSerializer(package)))
    {
        writer.WriteRecords(people);
    }
    // do other stuff with package
    package.SaveAs(new FileInfo("path/to/file.xlsx"));
}

When instances of ExcelPackage and ExcelWorksheet are passed to the constructor then the serialiser will not dispose or automatically save anything.

using (var package = new ExcelPackage())
{
    var worksheet = package.Workbook.Worksheets.Add("Folk");
    using (var writer = new CsvWriter(new ExcelSerializer(package, worksheet)))
    {
        writer.WriteRecords(people);
    }
    package.SaveAs(new FileInfo("path/to/file.xlsx"));
}

All constructor options have overloads allowing you to specify your own Configuration, otherwise the default is used.