Show / Hide Table of Contents

Class DocumentTemplateInfo

Information about the document template. Passed to plugins to avoid coupling them directly to database schema.

Inheritance
object
DocumentTemplateInfo
Implements
IDocumentTemplateInfo
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
Namespace: SuperOffice.CRM.Documents
Assembly: SoDataBase.dll
Syntax
public sealed class DocumentTemplateInfo : IDocumentTemplateInfo

Constructors

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(int)

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
int docTemplId

DocumentTemplateInfo(int, string, int, string, bool, 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
int id
string name
int rank
string tooltip
bool 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
int

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
int

IsDeleted

True, if the document is deleted.

Declaration
public bool IsDeleted { get; }
Property Value
Type Description
bool

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
int

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
int

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

Implements

IDocumentTemplateInfo

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top