The Template type exposes the following members.
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | Template(PackageTemplateLocation, String, String) |
Construct a Template object for the main template in a package.
|
| Template(String, TemplateLocation, String, String) |
Construct a Template object.
|
Methods
| Name | Description | |
|---|---|---|
| CreateLocator |
Returns a locator string to recreate the template object at a later time.
Use the Locate method to recreate the object.
|
|  Equals | (Inherited from Object.) |
| GetDocExtension |
Returns the assembled document extension associated with the NativeDocumentType property.
|
 | GetDocExtension(DocumentType, Template) |
Returns the assembled document extension for a specific document type.
|
| GetFullPath |
Returns the full path (based on the directory specified by Location.GetTemplateDirectory) of the template.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetManifest |
Gets the template manifest for this template. Can optionally parse an entire template manifest spanning tree.
See ManifestParseFlags for details.
|
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| Locate |
Returns a Template created from a locator string generated by CreateLocator.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateFileName |
Request that the Template.Location update the file name as needed.
|
Properties
| Name | Description | |
|---|---|---|
 | FileName |
The file name (including extension) of the template. No path information is included.
|
| GeneratesDocument |
Based on TemplateType, tells the host app whether this type of template
generates a document or not (although regardless, ALL template types
need to be assembled in order to participate in assembly queues)
|
| HasInterview |
Parses command-line switches to inform the host app whether or not
an interview should be displayed for this template.
|
| Key |
A key identifying the template. When using a template management scheme where the template file itself is temporary
(such as with a DMS) set this key to help HotDocs Server to keep track of which server files are for which template.
If not empty, this key is also used internally by HotDocs Server for caching purposes.
|
| Location |
Defines the location of the template.
|
| NativeDocumentType |
Based on the template file extension, get the document type native to the template type.
|
| Switches |
Command line switches that may be applicable when assembling the template, as provided to the ASSEMBLE instruction.
|
| TemplateType |
If the host app wants to know, this property does what's necessary to
tell you the type of template you're dealing with.
|
| Title |
The template title, which comes from the template's manifest file by default.
|
See Also