Kwolo.ExcelParser 1.1.0

Excel file parser

Purpose

This is a .net class library that wraps the somewhat impenetrable Open-XML-SDK nuget package (even the name is so non-Nuget, non-Microsoft, it's painful to look at...) to parse Excel files into a simple Worksheet model that comprises Rows that, you guessed it, consist of Cells.

As v1.1.0 we can also write an Excel file from the same model.

Nuget & source

Available on nuget at https://www.nuget.org/packages/Kwolo.ExcelParser/

Source on GitLab at https://gitlab.com/skotl/excel-parser

Usage: Parsed row, cell and value

RowModel

A RowModel has a row number (one-based) and a collection of CellModels.

CellModel

The CellModel comprises the following properties, all intended to make the cell as easy to work with as possible:

ValueModel

The ValueModel consists of a guessed data type (not all types are exposed by the raw Excel format) as well as potential parsed values as Dates, Strings, Integers, Decimals and Booleans.

Check ValueModel.DataType for the base type, which will be one of the following:

• StringType
• BoolType
• NumberType
• DateType

The properties on ValueModel include:

breaking change in 1.0.4: DateValue is only set if the cell was a DateType

Usage - reading an Excel file

Instantiate a new ExcelParser and call one of the Parse() methods:

public bool Parse(Stream excelFile, bool throwOnError = false)

public bool Parse(Stream excelFile, int worksheetNumber, bool throwOnError = false)

Where you can pass a combination of these parameters:

If throwOnError is false and an exception is thrown it is caught by the parser and the following properties are set:

Usage - writing an Excel file

Instantiate a new ExcelWriter and call the Write() method:

public bool Write(Stream excelFile, WorksheetModel worksheet, bool throwOnError = false)

Where you can pass a combination of these parameters:

If throwOnError is false and an exception is thrown it is caught by the parser and the following properties are set:

Sample app

The Source structure contains a test console application called Kwolo.ExcelParser.TestApp

This project contains a simple and a complex Excel file in the /ExcelFiles folder and dumps the contents of the rows and cells for each of these files. It also reads each of these files and writes new variants back out, demonstrating how the internal data models are written to Excel.

You can also pass the name of an Excel file as an argument if you want to try it out with your own file.

Tests

The Source structure contains an xunit test project called Kwolo.ExcelParser.Tests that should cover most of the model and parsing functionality.

Contributions

Contributions and issues welcome within GitLab - note that no warranty is offered and, while this is an actively maintained project (I use the package in several commercial and home-based apps), not everything may get fixed!

If you are keen to contribute then please be aware that high test coverage is expected.

License

See License file, here