HotDocs_Online Application Object
The Application object, representing the HotDocs Server application itself, exposes core HotDocs Server features in a more stateless fashion.
Interface Information
| ProgID: | HotDocs_Online.Application.11.0 |
| Version Independent ProgID: | HotDocs_Online.Application |
| CLSID: | {BA8ACA36-3A71-41B9-AE32-A33DF8211EEC} |
| _Application Interface: | IID: {30C8BD35-3CF6-4557-8FAC-CED51DDA4C81} |
| _Application2 Interface: | IID: {30C8BD36-3CF6-4557-8FAC-CED51DDA4C81} |
| _Application5 Interface: |
IID: {08B875A1-46F5-4CFC-A7B4-33B6FEC53CC1} Default interface introduced in HotDocs Server 11.1 |
| _ApplicationEvents Interface: | IID: {BA8ACA36-3A71-41B9-AE32-A33DF8211EEC} |
Methods
| Method | Description |
 AddLogEntry |
Add a new log entry. |
| AppendDocumentFile |
This method joins one document to the end of another document. |
| AppendDocumentFile2 |
This method joins one document to the end of another document. |
| AssembleDocument |
Assemble a document from a template. |
| AssembleDocument2 |
Assemble a document from a template. |
| BuildSupportFiles |
Build the support files needed for a template interview. |
| GetDocumentFileExtension |
Get the extension for a document that would be assembled from a template. |
| GetHotDocsVersion |
Return the version of HotDocs that was used to publish a template.
This method was deprecated in HotDocs Server 11. |
| GetInterview2 |
Get an interview for a template. |
| GetInterviewDefinitionFromState |
Get an interview definition for a template using a state string. |
| GetInterviewDefinitionFromTemplate |
Get an interview definition for a template using a template path |
| GetInterviewVersion |
Deprecated. Get the version number assigned by HotDocs to an interview definition. |
| JoinDocumentFiles |
This method can be used for joining two or more files by appending multiple documents to another. |
| RemoveSupportFiles |
Remove the files on the server needed for the template interview. |
Properties
| Property | Description |
 Assemblies |
The list of pending assemblies generated from the last call to AssembledDocument2. |
| MarkedVariables |
The list of unanswered variables generated from the last document assembly. |
| MarkedVariableSize |
The number of unanswered variables generated from the last assembly. |
| MarkedVariablesString |
The list of unanswered variables generated from the last document assembly. |
| PDFAdvantageInstalled |
This property returns a Boolean value indicating whether or not HotDocs Server can assemble PDF-based templates. You should check this property before assembling a PDF-based form (.HPT) template to avoid errors generated by attempting to assemble an .HPT template without PDF Advantage. |
| Version |
This property returns the HotDocs Server version number. For example, if HotDocs Server 11 is running, this property returns HotDocs Server 11. |