Ninjanaut.BinaryExcelReader 2.1.0

Ninjanaut.BinaryExcelReader

Welcome to the project website! BinaryExcelReader is lightweight C# library to ease loading data from binary Excel file format (XLSB) into DataTable object. Library is based on Microsoft OLE DB driver. Other formats XLS, XLSX and XLSM are also supported.

If you don't need to load XLSB format, consider to use excel reader without OLE DB driver dependency Ninjanaut.ExcelReader

Installation

from nuget package manager console

PM> Install-Package Ninjanaut.BinaryExcelReader

from command line

> dotnet add package Ninjanaut.BinaryExcelReader

Features

• Loading from file path via sheet name.
• Duplicate columns are implicitly allowed.
  • Columns A, B, B, B1 will be loaded as A, B, B1, B11 (this is OLE DB Driver default setting).
• Another options might be set via options parameter

Usage

using Ninjanaut.IO;

// Convert excel sheet into datatable object.
var path = @"C:\FooExcel.xlsx";
var sheetName = "Sheet1";
var datatable = BinaryExcelReader.ToDataTable(path, sheetName);

You can also override the default settings using the options parameter.

using Ninjanaut.IO;

// Convert excel sheet into datatable object using options parameter.
var path = @"C:\FooExcel.xlsx";
var sheetName = "Sheet1";
var options = new BinaryExcelReaderOptions 
{ 
    // Default settings:
    HeaderExists = true
    HeaderRowIndex = 0,
    RemoveEmptyRows = true,
    MaxColumns = null,
});

var datatable = BinaryExcelReader.ToDataTable(path, sheetName, options);

// Or the options object may be defined within the method directly.
var datatable = ExcelReader.ToDataTable(path, sheetName, new() { MaxColumns = 5 });

Notes

DataTable object is suitable for this purpose, because you can easily view the read data directly in Visual Studio for debug purposes, create a collection of entities from it or pass datatable as parameter directly into the SQL server stored procedure.

Release notes

Contribution

If you would like to contribute to the project, please send a pull request to the dev branch.