NanoXLSX.Internal.Readers.SharedStringsReader Class Reference

Class representing a reader for the shared strings table of XLSX files. More...

Inheritance diagram for NanoXLSX.Internal.Readers.SharedStringsReader:

Public Member Functions
	SharedStringsReader ()
	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 shared strings document.
List< string >	SharedStrings [get]
	List of shared string entries.
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.

Detailed Description

Class representing a reader for the shared strings table of XLSX files.

Definition at line 27 of file SharedStringsReader.cs.

Constructor & Destructor Documentation

SharedStringsReader()

NanoXLSX.Internal.Readers.SharedStringsReader.SharedStringsReader

(

)

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

Definition at line 69 of file SharedStringsReader.cs.

Member Function Documentation

Execute()

void NanoXLSX.Internal.Readers.SharedStringsReader.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 100 of file SharedStringsReader.cs.

Init()

void NanoXLSX.Internal.Readers.SharedStringsReader.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 84 of file SharedStringsReader.cs.

Property Documentation

DocumentType

virtual string NanoXLSX.Internal.Readers.SharedStringsReader.DocumentType

get

Gets the relationship type URI of a shared strings document.

Definition at line 41 of file SharedStringsReader.cs.

InlinePluginHandler

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

getset

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

Definition at line 62 of file SharedStringsReader.cs.

Options

IOptions NanoXLSX.Internal.Readers.SharedStringsReader.Options

getset

Reader options.

Definition at line 58 of file SharedStringsReader.cs.

SharedStrings

List<string> NanoXLSX.Internal.Readers.SharedStringsReader.SharedStrings

get

List of shared string entries.

String entry, sorted by its internal index of the table

Definition at line 49 of file SharedStringsReader.cs.

Workbook

Workbook NanoXLSX.Internal.Readers.SharedStringsReader.Workbook

getset

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

Definition at line 54 of file SharedStringsReader.cs.

---

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

• SharedStringsReader.cs