Class TemplateInfo
Information about a document template, i.e., a document that generally contains unresolved merge tags and that is used as the source for creating new documents. Used by plugins to describe templates to NetServer without using database records.
Namespace: SuperOffice.CRM.Documents
Assembly: SuperOffice.Plugins.dll
Syntax
public class TemplateInfo : ObjectRemarks
Document templates have traditionally been stored as files in the so_arc\template directory. They can now also be stored in repositories managed by document plugins; this class is the return value from the plugin to describe template details like the MIME type or the URL used to access the template contents.
It is expected that document templates are like any other document, but marked in some way that allows the document plugin to distinguish them. How templates get into the repository is not a subject for the document API. Document templates must be addressable using the same kind of 'externalReference' key as other documents, and must be possible to retrieve using the GetDocumentAsStream api.Constructors
TemplateInfo()
Information about a document template, i.e., a document that generally contains unresolved merge tags and that is used as the source for creating new documents. Used by plugins to describe templates to NetServer without using database records.
Declaration
public TemplateInfo()Remarks
Document templates have traditionally been stored as files in the so_arc\template directory. They can now also be stored in repositories managed by document plugins; this class is the return value from the plugin to describe template details like the MIME type or the URL used to access the template contents.
It is expected that document templates are like any other document, but marked in some way that allows the document plugin to distinguish them. How templates get into the repository is not a subject for the document API. Document templates must be addressable using the same kind of 'externalReference' key as other documents, and must be possible to retrieve using the GetDocumentAsStream api.Properties
Description
Document description, shown as a tooltip or in some extended description area.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Remarks
Document templates have traditionally been stored as files in the so_arc\template directory. They can now also be stored in repositories managed by document plugins; this class is the return value from the plugin to describe template details like the MIME type or the URL used to access the template contents.
It is expected that document templates are like any other document, but marked in some way that allows the document plugin to distinguish them. How templates get into the repository is not a subject for the document API. Document templates must be addressable using the same kind of 'externalReference' key as other documents, and must be possible to retrieve using the GetDocumentAsStream api.ExternalReference
Unique key that identifies the document so it can be retrieved. Could be URL, Filename or id. Stored as the DocTmpl.Filename.
Declaration
public string ExternalReference { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Remarks
Document templates have traditionally been stored as files in the so_arc\template directory. They can now also be stored in repositories managed by document plugins; this class is the return value from the plugin to describe template details like the MIME type or the URL used to access the template contents.
It is expected that document templates are like any other document, but marked in some way that allows the document plugin to distinguish them. How templates get into the repository is not a subject for the document API. Document templates must be addressable using the same kind of 'externalReference' key as other documents, and must be possible to retrieve using the GetDocumentAsStream api.MimeType
MIME type associated with the document. Some archives may need MIME types to correctly access documents. Others can leave this blank.
Declaration
public string MimeType { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Remarks
Document templates have traditionally been stored as files in the so_arc\template directory. They can now also be stored in repositories managed by document plugins; this class is the return value from the plugin to describe template details like the MIME type or the URL used to access the template contents.
It is expected that document templates are like any other document, but marked in some way that allows the document plugin to distinguish them. How templates get into the repository is not a subject for the document API. Document templates must be addressable using the same kind of 'externalReference' key as other documents, and must be possible to retrieve using the GetDocumentAsStream api.Name
Name of the document, shown in lists etc to the user.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Remarks
Document templates have traditionally been stored as files in the so_arc\template directory. They can now also be stored in repositories managed by document plugins; this class is the return value from the plugin to describe template details like the MIME type or the URL used to access the template contents.
It is expected that document templates are like any other document, but marked in some way that allows the document plugin to distinguish them. How templates get into the repository is not a subject for the document API. Document templates must be addressable using the same kind of 'externalReference' key as other documents, and must be possible to retrieve using the GetDocumentAsStream api.PluginId
ID of plugin that stores this template, so it can be retrieved
Declaration
public int PluginId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
Remarks
Document templates have traditionally been stored as files in the so_arc\template directory. They can now also be stored in repositories managed by document plugins; this class is the return value from the plugin to describe template details like the MIME type or the URL used to access the template contents.
It is expected that document templates are like any other document, but marked in some way that allows the document plugin to distinguish them. How templates get into the repository is not a subject for the document API. Document templates must be addressable using the same kind of 'externalReference' key as other documents, and must be possible to retrieve using the GetDocumentAsStream api.