Ninjanaut.ExcelReader
1.0.1
Prefix Reserved
dotnet add package Ninjanaut.ExcelReader --version 1.0.1
NuGet\Install-Package Ninjanaut.ExcelReader -Version 1.0.1
<PackageReference Include="Ninjanaut.ExcelReader" Version="1.0.1" />
paket add Ninjanaut.ExcelReader --version 1.0.1
#r "nuget: Ninjanaut.ExcelReader, 1.0.1"
// Install Ninjanaut.ExcelReader as a Cake Addin #addin nuget:?package=Ninjanaut.ExcelReader&version=1.0.1 // Install Ninjanaut.ExcelReader as a Cake Tool #tool nuget:?package=Ninjanaut.ExcelReader&version=1.0.1
Welcome to the ExcelReader project website! ExcelReader is lightweight C# library to ease loading data from Excel file into DataTable object, based on NPOI library.
Installation
from nuget package manager console
PM> Install-Package Ninjanaut.ExcelReader
from command line
> dotnet add package Ninjanaut.ExcelReader
Version | Targets |
---|---|
1.x | .NET 5 |
Features
Options | Defaults | Notes | |
---|---|---|---|
Supports xsl, xlsx and xlsm formats | Format | xlsx | |
Loading via sheet position or name | SheetIndex or SheetName | SheetIndex = 0 | Setting both will throw ArgumentException |
Skip top rows | HeaderRowIndex | 0 | |
Remove empty rows | RemoveEmptyRows | true | |
Allow duplicate columns | AllowDuplicateColumns | true | Duplicated column will be loaded as <column name>_<guid> |
Limit max columns to load | MaxColumns | null |
Usage
using Ninjanaut.IO;
// From file path
var path = @"C:\FooExcel.xlsx";
var datatable = ExcelReader.ToDataTable(path);
// Or from bytes
var path = @"C:\FooExcel.xlsx";
var bytes = File.ReadAllBytes(path);
var datatable = ExcelReader.ToDataTable(bytes);
you can also use options argument
using Ninjanaut.IO;
var path = @"C:\FooExcel.xlsx";
var options = new ExcelReaderOptions
{
// Default settings:
Format = ExcelReaderFormat.Xlsx,
SheetIndex = 0,
SheetName = null,
HeaderRowIndex = 0,
RemoveEmptyRows = true,
AllowDuplicateColumns = true,
MaxColumns = null
});
var datatable = ExcelReader.ToDataTable(path, options);
// The options can be defined within the method.
var datatable = ExcelReader.ToDataTable(path, new() { SheetName = "My Sheet" });
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.
Contribution
If you would like to contribute to the project, please send a pull request to the dev branch.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net5.0
- NPOI (>= 2.5.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.