TemplateLocation GetTemplateDirectory Method
Returns the directory for the template.

Namespace: HotDocs.Sdk
Assembly: HotDocs.Sdk (in HotDocs.Sdk.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax

public abstract string GetTemplateDirectory()

Return Value

Type: OnlineString

[Missing <returns> documentation for "M:HotDocs.Sdk.TemplateLocation.GetTemplateDirectory"]

Remarks

In a system where all template file names are unique, one directory may be used for all templates. Generally, however, each main template (e.g. a package's main template) should reside in a directory separate from other main templates. Each dependent template (e.g. a package template that is not the main template) should reside in the same directory as its main template.

A TemplateLocation class may be implemented by the host application, and may represent templates stored on the file system, in a DMS, in some other database, etc. However, when an actual template file path is needed, the TemplateLocation implementation is expected to provide a full path to the template directory, and ensure that the template itself and all of its dependencies exist in that directory.

The directory where the template exists should survive the serialization and deserialization of this object. If the file name needs to be updated at deserialization, the class should override the GetUpdatedFileName(Template, String ) method.

See Also