AssembleDocumentSettings Properties

The AssembleDocumentSettings type exposes the following members.

Properties

Name

Description

HotDocs uses this setting during assembly when it needs to interpret ambiguously-written date strings (for example, date format examples in which the day, month and/or year are all expressed as numbers). By default this property respects the behavior configured on the server. Also note that this property is only respected by HotDocs Cloud Services; HotDocs Server always adheres to the behavior as configured in the management console.

DefaultDateFormat

Specifies the default format example to be used when merging date values into text. By default this property respects the behavior configured on the server. Also note that this property is only respected by HotDocs Cloud Services; HotDocs Server always adheres to the behavior as configured in the management console.

DefaultUnansweredFormat

Dictates what to merge (by default) when a value for which no answer is available is merged into document text. By default this property respects the behavior configured on the server. Also note that this property is only respected by HotDocs Cloud Services; HotDocs Server always adheres to the behavior as configured in the management console.

Format

The output format into which the requested document should be assembled or converted. If you request a format that is different from the template's native format, the assembled document will be automatically converted into the requested format (if possible).

This property initializes to "Native" by default, which means a document will be generated in the format native to whichever template is used.

An exception will be thrown if you request an OutputFormat that is incompatible with the template format.

HonorCmpUnansweredFormat

Determines whether template author preferences (as specified in a HotDocs component file) should override the default UnansweredFormat specified by the host application. By default this property respects the behavior configured on the server. Also note that this property is only respected by HotDocs Cloud Services; HotDocs Server always adheres to the behavior as configured in the management console.

OutputOptions

If the requested OutputFormat is PDF, HTML or PlainText, this property can specify additional options specific to that output format. It is null by default, which causes HotDocs to output the requested document using its own internal defaults.

RetainTransientAnswers

If false, 'save="false"' answers will be filtered out of resulting answer set. Defaults to false. Note that regardless of this property, HotDocs will not filter out 'save="false"' answers if the assembly results in additional pending assemblies.

Settings

Collection of settings that can be specified when requesting a document assembly. Values may be provided for the following settings:

Setting Name	Description
DefaultDateFormat	"June 3, 1990", etc. Specifies the default format example to be used when merging date values into text.
DateOrder	"MDY" or "DMY" HotDocs uses this setting during assembly when it needs to interpret ambiguously-written date strings (for example, date format examples in which the day, month and/or year are all expressed as numbers).
UnansweredFormat	"Nothing" / "Underscores" / "Asterisks" / "[Variable]" / "* Variable *" Dictates what to merge (by default) when a value for which no answer is available is merged into document text. Corresponds to the "Unanswered variable placeholder" HotDocs setting.
HonorCmpUnansFormat	"true" or "false" Determines whether template author preferences (as specified in a HotDocs component file) should override the default UnansweredFormat specified by the host application. ("true" corresponds to the behavior of desktop HotDocs.)
RequestTimeout	(number of seconds) By default, HotDocs Cloud Services will assume a request to assemble a document has hung if the response takes longer than (a certain time). Setting RequestTimeout to another value can raise or lower the threshhold before HotDocs gives up on a request. For performance reasons, HotDocs Cloud Services may ignore values over a certain threshhold.
MaxRepeatCount	e.g. "100" The number of iterations through a WHILE loop HotDocs will perform before generating an error. For performance reasons, HotDocs Cloud Services may ignore values over a certain threshhold.
MaxRecursionDepth	e.g. "100" The maximum depth that may be reached by a recursive script in HotDocs before generating an error. For performance reasons, HotDocs Cloud Services may ignore values over a certain threshhold.
AssembleMarkedDocuments	"true" or "false" Dictates whether this document will be assembled traditionally ("false") or using markup view ("true").

When you do not explicitly provide values for any setting, the default values specified in the HotDocs Cloud Services Administrative Portal will be used.

UseMarkupSyntax

Dictates whether this document will be assembled traditionally ("false") or using markup view ("true").