NanoXLSX.Extensions.WorkbookReader Class Reference

Class, providing functions to read Workbooks either by file or stream. More...

Static Public Member Functions
static Workbook	Load (string filename, ReaderOptions options=null)
	Loads a workbook from a file.
static Workbook	Load (Stream stream, ReaderOptions options=null)
	Loads a workbook from a stream.
static async Task< Workbook >	LoadAsync (string filename, ReaderOptions options=null)
	Loads a workbook from a file asynchronously.
static async Task< Workbook >	LoadAsync (Stream stream, ReaderOptions options=null)
	Loads a workbook from a stream asynchronously.

Detailed Description

Class, providing functions to read Workbooks either by file or stream.

Definition at line 18 of file Extensions/WorkbookReader.cs.

Member Function Documentation

Load() [1/2]

Workbook NanoXLSX.Extensions.WorkbookReader.Load ( Stream stream, ReaderOptions options = null )

static

Loads a workbook from a stream.

Parameters

stream

Stream containing the workbook

///

Parameters

options

Import options to override the data types of columns or cells. These options can be used to cope with wrong interpreted data, caused by irregular styles

Returns

Workbook object

Exceptions

Exceptions.IOException

Throws IOException in case of an error

Definition at line 48 of file Extensions/WorkbookReader.cs.

Load() [2/2]

Workbook NanoXLSX.Extensions.WorkbookReader.Load ( string filename, ReaderOptions options = null )

static

Loads a workbook from a file.

Parameters

filename	Filename of the workbook
options	Import options to override the data types of columns or cells. These options can be used to cope with wrong interpreted data, caused by irregular styles

Returns

Workbook object

Exceptions

Exceptions.IOException

Throws IOException in case of an error

Definition at line 32 of file Extensions/WorkbookReader.cs.

LoadAsync() [1/2]

async Task< Workbook > NanoXLSX.Extensions.WorkbookReader.LoadAsync ( Stream stream, ReaderOptions options = null )

static

Loads a workbook from a stream asynchronously.

Parameters

stream

Stream containing the workbook

///

Parameters

options

Import options to override the data types of columns or cells. These options can be used to cope with wrong interpreted data, caused by irregular styles

Returns

Workbook object

Exceptions

Exceptions.IOException

Throws IOException in case of an error

Definition at line 80 of file Extensions/WorkbookReader.cs.

LoadAsync() [2/2]

async Task< Workbook > NanoXLSX.Extensions.WorkbookReader.LoadAsync ( string filename, ReaderOptions options = null )

static

Loads a workbook from a file asynchronously.

Parameters

filename	Filename of the workbook
options	Import options to override the data types of columns or cells. These options can be used to cope with wrong interpreted data, caused by irregular styles

Returns

Workbook object

Exceptions

IOException

Throws IOException in case of an error

Definition at line 64 of file Extensions/WorkbookReader.cs.

---

The documentation for this class was generated from the following file:

• Extensions/WorkbookReader.cs