Class DocTmplTableInfo

Table 'DocTmpl': DocTmpl list table. Describes templates available for writing new documents.

Inheritance
System.Object
TableInfo
DocTmplTableInfo
Implements
System.ICloneable
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("DocTmpl")]
public class DocTmplTableInfo : TableInfo, ICloneable
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Fields

DictionaryTableName

Conceptual name of table DocTmpl in the database dictionary: DocTmpl

Declaration
public const string DictionaryTableName = "DocTmpl"
Field Value
Type Description
System.String

Properties

Accelerator

Field 'accelerator' in table 'DocTmpl': Dictionary type UShort, .NET type: System.Int16

Accelerator key code for this template

Declaration
public UInt16FieldInfo Accelerator { get; }
Property Value
Type Description
UInt16FieldInfo

AutoeventId

Field 'autoevent_id' in table 'DocTmpl': Dictionary type Id, .NET type: System.Int32

Document plugin id - where the documents generated from this template are to be stored. Copied to the document.archiveProvider when document is created.

Declaration
public Int32FieldInfo AutoeventId { get; }
Property Value
Type Description
Int32FieldInfo

DefaultOref

Field 'default_oref' in table 'DocTmpl': Dictionary type String[240], .NET type: System.String

Processed via tag substitution to give document reference

Declaration
public StringFieldInfo DefaultOref { get; }
Property Value
Type Description
StringFieldInfo

DefaultPublishType

Field 'defaultPublishType' in table 'DocTmpl': Dictionary type Enum, .NET type: PublishType

Should documents based on this template be published=true? Default state of publish flag on documents.

Declaration
public PublishTypeFieldInfo DefaultPublishType { get; }
Property Value
Type Description
PublishTypeFieldInfo

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides

Deleted

Field 'deleted' in table 'DocTmpl': Dictionary type UShort, .NET type: System.Int16

0 -> record is active 1 -> record is 'deleted' and should not be shown in lists

Declaration
public UInt16FieldInfo Deleted { get; }
Property Value
Type Description
UInt16FieldInfo

DictionaryTableNumber

Table number for table DocTmpl in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration
public int DictionaryTableNumber { get; }
Property Value
Type Description
System.Int32

Direction

Field 'direction' in table 'DocTmpl': Dictionary type Enum, .NET type: DocTmplDirection

1 = incoming, 2 = outgoing, see EAppntDirection

Declaration
public DocTmplDirectionFieldInfo Direction { get; }
Property Value
Type Description
DocTmplDirectionFieldInfo

DocTmplId

Field 'DocTmpl_id' in table 'DocTmpl': Dictionary type PK, .NET type: System.Int32

Primary key

Declaration
public Int32FieldInfo DocTmplId { get; }
Property Value
Type Description
Int32FieldInfo

EmailSubject

Field 'emailSubject' in table 'DocTmpl': Dictionary type String[4001], .NET type: System.String

Subject line for document templates that represent an email; template tags are accepted in this item

Declaration
public StringFieldInfo EmailSubject { get; }
Property Value
Type Description
StringFieldInfo

Filename

Field 'filename' in table 'DocTmpl': Dictionary type String[240], .NET type: System.String

Relative to TemplatePath in SOARC. Plugin specific extref in other doc archives. i.e. Google document URL or Notes id.

Declaration
public StringFieldInfo Filename { get; }
Property Value
Type Description
StringFieldInfo

IncludeSignature

Field 'includeSignature' in table 'DocTmpl': Dictionary type Bool, .NET type: System.Int16

If True, signature (mail.htm) should be added at bottom of template when used

Declaration
public UInt16FieldInfo IncludeSignature { get; }
Property Value
Type Description
UInt16FieldInfo

IntentId

Field 'intentId' in table 'DocTmpl': Dictionary type FK, target: Intent, .NET type: System.Int32

What is the intention of this document (used by SAINT)

Declaration
public Int32FieldInfo IntentId { get; }
Property Value
Type Description
Int32FieldInfo

IntentId_InnerJoin_Intent

Generated join from the foreign key IntentId in this table, to its target table IntentTableInfo.

Declaration
public TargetedInnerJoin<IntentTableInfo> IntentId_InnerJoin_Intent { get; }
Property Value
Type Description
TargetedInnerJoin<IntentTableInfo>

InvitationDocType

Field 'invitationDocType' in table 'DocTmpl': Dictionary type Enum, .NET type: DocTmplInvitationType

Type for sending email meeting invitation. Not an invitation type template = 0, New = 1, Changed = 2, Cancelled = 3

Declaration
public DocTmplInvitationTypeFieldInfo InvitationDocType { get; }
Property Value
Type Description
DocTmplInvitationTypeFieldInfo

LeftOuterJoin_ConsentSource_MailTemplateId

Generated left outer join from the primary key DocTmplId on this table, to ConsentSource.MailTemplateId.

Declaration
public TargetedLeftOuterJoin<ConsentSourceTableInfo> LeftOuterJoin_ConsentSource_MailTemplateId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<ConsentSourceTableInfo>

Generated left outer join from the primary key DocTmplId on this table, to DocTmplGroupLink.DocTmplId.

Declaration
public TargetedLeftOuterJoin<DocTmplGroupLinkTableInfo> LeftOuterJoin_DocTmplGroupLink_DocTmplId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<DocTmplGroupLinkTableInfo>

Generated left outer join from the primary key DocTmplId on this table, to DocTmplHeadingLink.DocTmplId.

Declaration
public TargetedLeftOuterJoin<DocTmplHeadingLinkTableInfo> LeftOuterJoin_DocTmplHeadingLink_DocTmplId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<DocTmplHeadingLinkTableInfo>

LeftOuterJoin_SaleType_ConfirmationLinesTemplate

Generated left outer join from the primary key DocTmplId on this table, to SaleType.ConfirmationLinesTemplate.

Declaration
public TargetedLeftOuterJoin<SaleTypeTableInfo> LeftOuterJoin_SaleType_ConfirmationLinesTemplate { get; }
Property Value
Type Description
TargetedLeftOuterJoin<SaleTypeTableInfo>

LeftOuterJoin_SaleType_QuoteLinesTemplate

Generated left outer join from the primary key DocTmplId on this table, to SaleType.QuoteLinesTemplate.

Declaration
public TargetedLeftOuterJoin<SaleTypeTableInfo> LeftOuterJoin_SaleType_QuoteLinesTemplate { get; }
Property Value
Type Description
TargetedLeftOuterJoin<SaleTypeTableInfo>

LeftOuterJoin_SuggestedDocument_DocTmplId

Generated left outer join from the primary key DocTmplId on this table, to SuggestedDocument.DocTmplId.

Declaration
public TargetedLeftOuterJoin<SuggestedDocumentTableInfo> LeftOuterJoin_SuggestedDocument_DocTmplId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<SuggestedDocumentTableInfo>

LoadTemplateFromPlugin

Field 'loadTemplateFromPlugin' in table 'DocTmpl': Dictionary type Int, .NET type: System.Int32

If nonzero, then this is the ID of the document plugin that should supply the template document file, instead of the default so_arc/template

Declaration
public Int32FieldInfo LoadTemplateFromPlugin { get; }
Property Value
Type Description
Int32FieldInfo

MimeType

Field 'mimeType' in table 'DocTmpl': Dictionary type String[255], .NET type: System.String

The MIME type, for Web/Browser use of documents of this type

Declaration
public StringFieldInfo MimeType { get; }
Property Value
Type Description
StringFieldInfo

Name

Field 'name' in table 'DocTmpl': Dictionary type String[240], .NET type: System.String

The list item

Declaration
public StringFieldInfo Name { get; }
Property Value
Type Description
StringFieldInfo

PrivacyDocType

Field 'privacyDocType' in table 'DocTmpl': Dictionary type Enum, .NET type: DocTmplPrivacyType

Indicator that this document template has a functional role, related to privacy/GDPR

Declaration
public DocTmplPrivacyTypeFieldInfo PrivacyDocType { get; }
Property Value
Type Description
DocTmplPrivacyTypeFieldInfo

QuoteDocType

Field 'quoteDocType' in table 'DocTmpl': Dictionary type Enum, .NET type: DocTmplQuoteType

The role this document plays in the Quote system, if any

Declaration
public DocTmplQuoteTypeFieldInfo QuoteDocType { get; }
Property Value
Type Description
DocTmplQuoteTypeFieldInfo

Rank

Field 'rank' in table 'DocTmpl': Dictionary type UShort, .NET type: System.Int16

Rank order

Declaration
public UInt16FieldInfo Rank { get; }
Property Value
Type Description
UInt16FieldInfo

RecordType

Field 'record_type' in table 'DocTmpl': Dictionary type Enum, .NET type: DocTmplType

1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes

Declaration
public DocTmplTypeFieldInfo RecordType { get; }
Property Value
Type Description
DocTmplTypeFieldInfo

Registered

Field 'registered' in table 'DocTmpl': Dictionary type UtcDateTime, .NET type: System.DateTime

Registered when

Declaration
public DateTimeFieldInfo Registered { get; }
Property Value
Type Description
DateTimeFieldInfo

RegisteredAssociateId

Field 'registered_associate_id' in table 'DocTmpl': Dictionary type FK, target: Associate, .NET type: System.Int32

Registered by whom

Declaration
public Int32FieldInfo RegisteredAssociateId { get; }
Property Value
Type Description
Int32FieldInfo

RegisteredAssociateId_InnerJoin_Associate

Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>

RegkeyEdit

Field 'regkey_edit' in table 'DocTmpl': Dictionary type String[240], .NET type: System.String

Registry key to use for Edit; if blank, we simply ask Windows to do the operation for us

Declaration
public StringFieldInfo RegkeyEdit { get; }
Property Value
Type Description
StringFieldInfo

RegkeyOpen

Field 'regkey_open' in table 'DocTmpl': Dictionary type String[240], .NET type: System.String

Registry key to use for Open, if blank, we simply ask Windows to do the operation for us

Declaration
public StringFieldInfo RegkeyOpen { get; }
Property Value
Type Description
StringFieldInfo

RegkeyPrint

Field 'regkey_print' in table 'DocTmpl': Dictionary type String[240], .NET type: System.String

Registry key to use for Print; if blank, we simply ask Windows to do the operation for us

Declaration
public StringFieldInfo RegkeyPrint { get; }
Property Value
Type Description
StringFieldInfo

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration
public static SoTable RuntimeDefinition { get; }
Property Value
Type Description
SoTable

SaveInDb

Field 'saveInDb' in table 'DocTmpl': Dictionary type UShort, .NET type: System.Int16

1 = save document records in DB; otherwise not.

Declaration
public UInt16FieldInfo SaveInDb { get; }
Property Value
Type Description
UInt16FieldInfo

SenderEmailAddress

Field 'senderEmailAddress' in table 'DocTmpl': Dictionary type String[257], .NET type: System.String

The email address to use in from field

Declaration
public StringFieldInfo SenderEmailAddress { get; }
Property Value
Type Description
StringFieldInfo

SenderEmailMode

Field 'senderEmailMode' in table 'DocTmpl': Dictionary type Enum, .NET type: SenderMailMode

Type of sender email setting. Always use senderEmailAddress = 0, Use Our contact = 1, Use Support Associate = 2

Declaration
public SenderMailModeFieldInfo SenderEmailMode { get; }
Property Value
Type Description
SenderMailModeFieldInfo

ShowCurrents

Field 'showCurrents' in table 'DocTmpl': Dictionary type Bool, .NET type: System.Int16

If True, A dialog or sidebar will be shown for changing current values on Contact, Person

Declaration
public UInt16FieldInfo ShowCurrents { get; }
Property Value
Type Description
UInt16FieldInfo

Tooltip

Field 'tooltip' in table 'DocTmpl': Dictionary type String[255], .NET type: System.String

Tooltip or other description

Declaration
public StringFieldInfo Tooltip { get; }
Property Value
Type Description
StringFieldInfo

Updated

Field 'updated' in table 'DocTmpl': Dictionary type UtcDateTime, .NET type: System.DateTime

Last updated when

Declaration
public DateTimeFieldInfo Updated { get; }
Property Value
Type Description
DateTimeFieldInfo

UpdatedAssociateId

Field 'updated_associate_id' in table 'DocTmpl': Dictionary type FK, target: Associate, .NET type: System.Int32

Last updated by whom

Declaration
public Int32FieldInfo UpdatedAssociateId { get; }
Property Value
Type Description
Int32FieldInfo

UpdatedAssociateId_InnerJoin_Associate

Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>

UpdatedCount

Field 'updatedCount' in table 'DocTmpl': Dictionary type UShort, .NET type: System.Int16

Number of updates made to this record

Declaration
public UInt16FieldInfo UpdatedCount { get; }
Property Value
Type Description
UInt16FieldInfo

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)