The AssembleDocumentSettings type exposes the following members.
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
![]() | AssembleDocumentSettings |
Creates a new copy of the default assembly settings. Override the built-in defaults with your preferred
defaults by adding appropriate settings to the appSettings section of your web.config file.
|
![]() | AssembleDocumentSettings(AssembleDocumentSettings) |
Copy constructor -- this constructor is invoked to make a new copy of the (static) Default AssembleDocumentSettings
(as originally read from web.config).
|
Methods
Name | Description | |
---|---|---|
![]() | ![]() | (Inherited from ![]() |
![]() | ![]() | Serves as a hash function for a particular type. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
Properties
Name | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | DateOrderPreference |
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:
| ||||||||||||||||||
![]() | UseMarkupSyntax |
Dictates whether this document will be assembled traditionally ("false") or using markup view ("true").
|
See Also