appastoy / FastXL

Fast excel file reader C# library.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FastXL

This project is a fast excel file reader C# library. This supports only read. NOT write.

.NET Test .NET Publish NuGet version (AppAsToy.FastXL)

GitHub: https://github.com/appastoy/FastXL

NuGet: https://www.nuget.org/packages/AppAsToy.FastXL

How to

Excel file(.xlsx, .xlsm) is a set of XML files that are compressed to zip archive. This library reads XML files in zip archive directly. Especially, For performance, It uses XmlReader instance to parsing forward. So you can access minimum things of excel file specification.

Example

Load excel file.

using AppAsToy.FastXL;

// Load book (without all sheets unloaded)
var book = ExcelFile.LoadBook("test.xlsx");

// Load book (with all sheets loaded)
var book = ExcelFile.LoadBook("test.xlsx", loadAllSheet = true);

Access workbook.

using AppAsToy.FastXL;

var book = ExcelFile.LoadBook("test.xlsx");

// Get sheet by sheet name.
var sheet1 = book["Sheet1"];

// Get sheet by sheet index.
var sheet2 = book[0];

// Iterate sheet list. (read only list)
foreach (var sheet in book.Sheets)
{
  // ...
}

Access worksheet.

using AppAsToy.FastXL;

var book = ExcelFile.LoadBook("test.xlsx");
var sheet = book["Sheet1"];

// Get sheet name.
var sheetName = sheet.Name;

// Get row count.
var rowCount = sheet.RowCount;

// Get column count.
var columnCount = sheet.ColumnCount;

// Get cell count. (row x column)
var cellCount = sheet.CellCount;

// Is sheet loaded?
var isLoaded = sheet.IsLoaded;

// Load sheet. (It loads once. Second load call do nothing.
sheet.Load();

// Get cell value.
var cellValue = sheet.Cell(row=1, column=2);

About

Fast excel file reader C# library.

License:MIT License


Languages

Language:C# 100.0%