DocumentTableSet class Leave feedback
On this page
Provides access to data of multiple tables (or spreadsheets) located in an external document to be used while assembling a document. Also enables defining parent‑child relations for the document tables, simplifying access to related data within template documents.
For documents of spreadsheet file formats, a DocumentTableSet instance represents a set of sheets. For documents of other file formats, a DocumentTableSet instance represents a set of tables.
To access data of the corresponding tables while assembling a document, pass an instance of this class as a data source to one of DocumentAssembler overloads.
In template documents, a DocumentTableSet instance should be treated the same way as a System.Data.DataSet instance. See the template syntax reference for more information.
The DocumentTableSet type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new DocumentTableSet loading all tables from a document using default DocumentTableOptions. |
| init | Initializes a new DocumentTableSet. |
| init | Initializes a new DocumentTableSet loading all tables from a document using default DocumentTableOptions. |
| init | Initializes a new DocumentTableSet instance. |
| Property | Description |
|---|---|
| relations | The collection of parent‑child relations defined for document tables of this set. |
| tables | The collection of DocumentTable objects representing tables of this set. |
from groupdocs.assembly import DataSourceInfo, DocumentAssembler
from groupdocs.assembly.data import DocumentTableOptions, DocumentTableSet
def load_table(args):
# The first row of every table holds its column names
options = DocumentTableOptions()
options.first_row_contains_column_names = True
args.options = options
# Load all tables from an Excel file
tables = DocumentTableSet("related-tables.xlsx", load_table)
# Define parent‑child relations between tables
tables.relations.add(
tables.tables["CLIENT"].columns["ID"],
tables.tables["CONTRACT"].columns["CLIENT_ID"]
)
tables.relations.add(
tables.tables["MANAGER"].columns["ID"],
tables.tables["CONTRACT"].columns["MANAGER_ID"]
)
# Use the tables as a data source for document assembly
assembler = DocumentAssembler()
assembler.assemble_document(
"table-relations.docx",
"table-relations-report.docx",
DataSourceInfo(tables)
)
Task guides that use DocumentTableSet:
- module
groupdocs.assembly.data
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
