NanoXLSX.Internal.Readers.WorksheetReader Class Reference

Class representing a reader for worksheets of XLSX files. More...

Inheritance diagram for NanoXLSX.Internal.Readers.WorksheetReader:

Public Member Functions
	WorksheetReader ()
	Default constructor - Must be defined for instantiation of the plug-ins.
void	Init (Stream stream, Workbook workbook, IOptions readerOptions, Action< Stream, Workbook, string, IOptions, int?> inlinePluginHandler)
	Initialization method (interface implementation).
void	Execute ()
	Method to execute the main logic of the plug-in (interface implementation).

Properties
virtual string	DocumentType [get]
	Gets the relationship type URI of a worksheet document.
Workbook	Workbook [get, set]
	Workbook reference where read data is stored (should not be null).
IOptions	Options [get, set]
	Reader options.
Action< Stream, Workbook, string, IOptions, int?>	InlinePluginHandler [get, set]
	Reference to the ReaderPlugInHandler, to be used for post operations in the Execute method.
int	CurrentWorksheetID [get, set]
	Gets or sets the (r)ID of the current worksheet.
List< String >	SharedStrings [get, set]
	Gets or sets the list of shared strings. The index of the list corresponds to the index defined in cell values. A null value indicates that the workbook has no usable shared strings relationship.

Detailed Description

Class representing a reader for worksheets of XLSX files.

Definition at line 31 of file WorksheetReader.cs.

Constructor & Destructor Documentation

WorksheetReader()

NanoXLSX.Internal.Readers.WorksheetReader.WorksheetReader

(

)

Default constructor - Must be defined for instantiation of the plug-ins.

Definition at line 77 of file WorksheetReader.cs.

Member Function Documentation

Execute()

void NanoXLSX.Internal.Readers.WorksheetReader.Execute

(

)

Method to execute the main logic of the plug-in (interface implementation).

Exceptions

Exceptions.IOException

Throws an IOException in case of a error during reading

Definition at line 113 of file WorksheetReader.cs.

Init()

void NanoXLSX.Internal.Readers.WorksheetReader.Init	(	Stream	stream,
		Workbook	workbook,
		IOptions	readerOptions,
		Action< Stream, Workbook, string, IOptions, int?>	inlinePluginHandler )

Initialization method (interface implementation).

Parameters

stream	MemoryStream to be read
workbook	Workbook reference
readerOptions	Reader options
inlinePluginHandler	Reference to the a handler action, to be used for post operations in reader methods

Definition at line 90 of file WorksheetReader.cs.

Property Documentation

CurrentWorksheetID

int NanoXLSX.Internal.Readers.WorksheetReader.CurrentWorksheetID

getset

Gets or sets the (r)ID of the current worksheet.

Definition at line 64 of file WorksheetReader.cs.

DocumentType

virtual string NanoXLSX.Internal.Readers.WorksheetReader.DocumentType

get

Gets the relationship type URI of a worksheet document.

Definition at line 47 of file WorksheetReader.cs.

InlinePluginHandler

Action<Stream, Workbook, string, IOptions, int?> NanoXLSX.Internal.Readers.WorksheetReader.InlinePluginHandler

getset

Reference to the ReaderPlugInHandler, to be used for post operations in the Execute method.

Definition at line 60 of file WorksheetReader.cs.

Options

IOptions NanoXLSX.Internal.Readers.WorksheetReader.Options

getset

Reader options.

Definition at line 56 of file WorksheetReader.cs.

SharedStrings

List<String> NanoXLSX.Internal.Readers.WorksheetReader.SharedStrings

getset

Gets or sets the list of shared strings. The index of the list corresponds to the index defined in cell values. A null value indicates that the workbook has no usable shared strings relationship.

Definition at line 70 of file WorksheetReader.cs.

Workbook

Workbook NanoXLSX.Internal.Readers.WorksheetReader.Workbook

getset

Workbook reference where read data is stored (should not be null).

Definition at line 52 of file WorksheetReader.cs.

---

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

• WorksheetReader.cs