Skip to main content

IWorkspace.GenerateDocument Method

Namespace: NextDesign.Desktop

Description

Generates a document.
The selected element in the Model Navigator is used as the base model for output.

Argument

NameTypeDescription
optionsDocumentGenerationOptionsDocument Generation Options

Return value

Exception

NameException ClassDescription
UnsupportedExtensionNotSupportedExceptionWhen the current edition of the application does not support it
Invalid ArgumentExtensionArgumentExceptionWhen a string other than the default string is specified for options.Format
When a string other than the default string is specified for options.Scope
When null or an empty string is specified for options.OutputPath
When options.ExportFigureAsPng is false and options.IncludeImageFileLinksInDocument is true If you specify:
options.ExportLargeTablesAsExcel is false and options.IncludeTableFileLinksInDocument is true
options.Format is "word" or "pdf" and the string length of the path specified in options.OutputPath exceeds 240 characters
options.Format is "html" and options.Scope is "current" and the path length calculated by the following formula including the string length of the path specified in options.OutputPath exceeds 240
・{string length of the path specified in options.OutputPath} + 41
options.Format is "html" and options.Scope is "all" or "allchildren" and the path length calculated by the following formula including the string length of the path specified in options.OutputPath exceeds 240
・{string length of the path specified in options.OutputPath} + 48
Invalid PathExtensionInvalidPathExceptionIf options.OutputPath cannot be interpreted as a valid path string