Class DocumentTemplateInfo
Information about the document template. Passed to plugins to avoid coupling them directly to database schema.
Implements
Namespace: SuperOffice.CRM.Documents
Assembly: SoDataBase.dll
Syntax
public sealed class DocumentTemplateInfo : Object, IDocumentTemplateInfoConstructors
DocumentTemplateInfo(DocTmplRow)
Information about the document template. Passed to plugins to avoid coupling them directly to database schema.
Declaration
public DocumentTemplateInfo(DocTmplRow documentTemplateRow)Parameters
| Type | Name | Description |
|---|---|---|
| DocTmplRow | documentTemplateRow |
DocumentTemplateInfo(Int32)
Information about the document template. Passed to plugins to avoid coupling them directly to database schema.
Declaration
public DocumentTemplateInfo(int docTemplId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | docTemplId |
DocumentTemplateInfo(Int32, String, Int32, String, Boolean, String, String)
Information about the document template. Passed to plugins to avoid coupling them directly to database schema.
Declaration
public DocumentTemplateInfo(int id, string name, int rank, string tooltip, bool isDeleted, string fileName, string mimeType)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | id | |
| String | name | |
| Int32 | rank | |
| String | tooltip | |
| Boolean | isDeleted | |
| String | fileName | |
| String | mimeType |
Properties
DocumentStoredInPluginId
The id of the document plugin that handles the document generated from the template. i.e. the destination plugin. Stored in DocTmpl.AutoEventId in the database.
Declaration
public int DocumentStoredInPluginId { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
ExternalReference
Physical name of the document template. URL or Filename of the content. Stored in database as DocTmpl.Filename
Declaration
public string ExternalReference { get; }Property Value
| Type | Description |
|---|---|
| String |
Id
Primary key of the document template.
Declaration
public int Id { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
IsDeleted
True, if the document is deleted.
Declaration
public bool IsDeleted { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
MimeType
Mime Type of the document template. Set by the document plugin during template creation.
Declaration
public string MimeType { get; }Property Value
| Type | Description |
|---|---|
| String |
Name
Display Name of the document template (in lists).
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| String |
Rank
Order for the document template.
Declaration
public int Rank { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Registered
When the template was created.
Declaration
public DateTime Registered { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
TemplateStoredInPluginId
The id of the document plugin that handles the document template. i.e. the source plugin. Stored in DocTmpl.LoadTemplateFromPlugin in the database.
Declaration
public int TemplateStoredInPluginId { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Tooltip
Tooltip description for the document template
Declaration
public string Tooltip { get; }Property Value
| Type | Description |
|---|---|
| String |
Updated
When the template was last updated.
Declaration
public DateTime Updated { get; }Property Value
| Type | Description |
|---|---|
| DateTime |