The project contains a series of components which gives the user the ability to load and save Excel files (2007 and newer) and access or change rows and cells. It also provides a fluent mapping interface similar to the concepts for Automapper or CsvHelper to map the Excel files to entities.
Description of how to start working with library
Add the extension package to your project(s)
Install-Package LittleBlocks.Excel.Extensions
or
dotnet add package LittleBlocks.Excel.Extensions
Then you can add the following code to your startup to enable excel support in ServiceCollection
services.AddExcel();it adds the following services to your application
serviceCollection.AddTransient<IExcelMapperBuilder, ExcelMapperBuilder>(); // Used for excel schema mapping
serviceCollection.AddTransient<IWorkbookLoader, WorkbookLoader>(); // Used for direct excel manipulation. Needed by previous serviceNow you cane work with IWorkbookLoader to load the excel file from file or stream
var workbookLoader = serviceProvider.GetRequiredService<IWorkbookLoader>();
var workbook = workbook.Load("filename");
// Manipulate the file
workbook.Save("Another file");Or you can ExcelMapperBuilder to map and load the excel into an entity
public sealed class PersonModel
{
public string Name { get; set; }
public string PersonName { get; set; }
public string PersonNameContainsSpecialCharacter { get; set; }
public decimal? AmountInCurrency { get; set; }
public string Currency { get; set; }
public decimal? Salary { get; set; }
public DateTime? BirthDate { get; set; }
public string CountryName { get; set; }
public bool? Certified { get; set; }
public int? CertificationId { get; set; }
public int? CustomRowNumber { get; set; }
}
// ...
var builder = serviceProvider.GetService<IExcelMapperBuilder>();
var workbook = workbook.Load("filename");
var mapper = builder.Build(workbook);
var personList = mapper.Map<PersonModel>("Sheet1", opt =>
opt.ForMember(m => m.CustomRowNumber, Resolve.ByValue("Custom Identification No"))).ToList()
Important Notes: We are using WINDOWS specific drawing library System.Drawing.Common which is a port for GDI+ on Windows, this solution may not be the best, possibly look for alternatives.
Description of the steps or process to be a contributor to the project.
Some of the best ways to contribute are to try things out, file issues, join in design conversations, and make pull-requests.
- Be an active contributor: Check out the contributing page to see the best places to log issues and start discussions.
- Roadmap: The schedule and milestone themes for project.
Security issues and bugs should be reported by creating the relevant features and bugs in issues sections