Class representing a reader to decompile XLSX files. More...

Inheritance diagram for NanoXLSX.Internal.Readers.XlsxReader:

Public Member Functions
	XlsxReader (string path, ReaderOptions options=null)
	Constructor with file path as parameter.
	XlsxReader (Stream stream, ReaderOptions options=null)
	Constructor with stream as parameter.
void	Read ()
	Reads the XLSX file from a file path or a file stream.
async Task	ReadAsync ()
	Reads the XLSX file from a file path or a file stream asynchronously.
void	Dispose ()
	Disposes the XlsxReader instance.

Properties
Workbook	Workbook `[get, set]`
	Gets the read workbook.

Detailed Description

Class representing a reader to decompile XLSX files.

Definition at line 27 of file XlsxReader.cs.

Constructor & Destructor Documentation

◆ XlsxReader() [1/2]

NanoXLSX.Internal.Readers.XlsxReader.XlsxReader	(	string	path,
		ReaderOptions	options = null )

Constructor with file path as parameter.

Parameters

options	Reader options to override the automatic approach of the reader. ReaderOptions for information about Reader options.
path	File path of the XLSX file to load

Definition at line 49 of file XlsxReader.cs.

◆ XlsxReader() [2/2]

NanoXLSX.Internal.Readers.XlsxReader.XlsxReader	(	Stream	stream,
		ReaderOptions	options = null )

Constructor with stream as parameter.

Parameters

options	Reader options to override the automatic approach of the reader. ReaderOptions for information about Reader options.
stream	Stream of the XLSX file to load

Definition at line 60 of file XlsxReader.cs.

Member Function Documentation

◆ Dispose()

void NanoXLSX.Internal.Readers.XlsxReader.Dispose ( )

Disposes the XlsxReader instance.

Definition at line 347 of file XlsxReader.cs.

◆ Read()

void NanoXLSX.Internal.Readers.XlsxReader.Read ( )

Reads the XLSX file from a file path or a file stream.

Exceptions

NanoXLSX.Exceptions.IOException Throws IOException in case of an error

Definition at line 75 of file XlsxReader.cs.

◆ ReadAsync()

async Task NanoXLSX.Internal.Readers.XlsxReader.ReadAsync ( )

Reads the XLSX file from a file path or a file stream asynchronously.

Exceptions

NanoXLSX.Exceptions.IOException May throw an IOException in case of an error. The asynchronous operation may hide the exception.

Returns: Task object (void)

Definition at line 105 of file XlsxReader.cs.

Property Documentation

◆ Workbook

Workbook NanoXLSX.Internal.Readers.XlsxReader.Workbook

getset

Gets the read workbook.

Definition at line 40 of file XlsxReader.cs.

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

XlsxReader.cs

Public Member Functions

Properties