Skip to main content

DocumentGenerationOptions Interface

Namespace: NextDesign.Desktop.DocumentGenerator

Description

Document generation options.

Area

NameDescription
Document GenerationAPIs for accessing document generation.

Property

NameDescription
ExportFiguresAsPngSpecifies whether to export diagrams externally.
If true, diagrams will be exported externally.
The default value is false.
ExportLargeTablesAsExcelSpecifies whether to export the tree grid externally.
If true, the diagram will be exported externally.
The default value is false.
FormatOutput format.
- "word" : Word format
- "pdf" : PDF format
- "html" : HTML format
IncludeImageFileLinksInDocumentSpecifies whether to output links to the externally exported diagram.
If true, links to the externally exported diagram will be output in the document.
The default value is false.
IncludeTableFileLinksInDocumentSpecifies whether to output links to externally outputted tree grids.
If true, links to externally outputted tree grids will be output to the document.
The default value is false.
OpenDocumentSpecifies whether to open the outputted file.
If true, the outputted file will be opened with the default application after the document is output.
The default value is true.
OutputPathThe folder path or file path to output to.
- For HTML: Please specify the output folder.
- For Word/PDF: Please specify the output file path.
ScopeSpecifies the scope.
- "all": Outputs everything.
- "allchildren": Outputs from the selected element to the end.
- "current": Outputs only the selected element.