DocumentTable class

DocumentTable class

Provides access to data of a single table (or spreadsheet) located in an external document to be used while assembling a document.

The DocumentTable type exposes the following members:

Constructors

Constructor Description
init Creates a new instance of this class using default DocumentTableOptions.
init Creates a new instance of this class.
init Creates a new instance of this class using default DocumentTableOptions.
init Creates a new instance of this class.

Properties

Property Description
name Gets or sets the name of this table used to access the table’s data in a template document passed to
DocumentAssembler.
index_in_document Gets the original zero-based index of the corresponding table as per the source document.
columns Gets the collection of DocumentTableColumn objects representing columns of
the corresponding table.

Remarks

For documents of Spreadsheet file formats, a DocumentTable instance represents a single sheet. For documents of other file formats, a DocumentTable instance represents a single table.

To access data of the corresponding table while assembling a document, pass an instance of this class as a data source to one of DocumentAssembler. overloads.

In template documents, a DocumentTable instance should be treated in the same way as if it was a DataTable instance. See template syntax reference for more information.

See Also