Class DocTmplRecordData

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the DocTmpl table.

Inheritance
object
DocTmplRecordData
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class DocTmplRecordData
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Constructors

DocTmplRecordData()

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the DocTmpl table.

Declaration
public DocTmplRecordData()
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Fields

Accelerator

Accelerator key code for this template

Declaration
public short Accelerator
Field Value
Type Description
short
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

AutoeventId

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 int AutoeventId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

DefaultOref

Processed via tag substitution to give document reference

Declaration
public string DefaultOref
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

DefaultPublishType

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

Declaration
public PublishType DefaultPublishType
Field Value
Type Description
PublishType
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Deleted

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

Declaration
public short Deleted
Field Value
Type Description
short
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Direction

1 = incoming, 2 = outgoing, see EAppntDirection

Declaration
public DocTmplDirection Direction
Field Value
Type Description
DocTmplDirection
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

DocTmplId

Primary key

Declaration
public int DocTmplId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

EmailSubject

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

Declaration
public string EmailSubject
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Filename

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

Declaration
public string Filename
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

IncludeSignature

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

Declaration
public short IncludeSignature
Field Value
Type Description
short
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

IntentId

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

Declaration
public int IntentId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

InvitationDocType

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

Declaration
public DocTmplInvitationType InvitationDocType
Field Value
Type Description
DocTmplInvitationType
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

LoadTemplateFromPlugin

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 int LoadTemplateFromPlugin
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

MimeType

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

Declaration
public string MimeType
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Name

The list item

Declaration
public string Name
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

PrivacyDocType

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

Declaration
public DocTmplPrivacyType PrivacyDocType
Field Value
Type Description
DocTmplPrivacyType
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

QuoteDocType

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

Declaration
public DocTmplQuoteType QuoteDocType
Field Value
Type Description
DocTmplQuoteType
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Rank

Rank order

Declaration
public short Rank
Field Value
Type Description
short
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RecordType

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

Declaration
public DocTmplType RecordType
Field Value
Type Description
DocTmplType
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Registered

Registered when in UTC.

Declaration
public DateTime Registered
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegisteredAssociateId

Registered by whom

Declaration
public int RegisteredAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegkeyEdit

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

Declaration
public string RegkeyEdit
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegkeyOpen

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

Declaration
public string RegkeyOpen
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegkeyPrint

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

Declaration
public string RegkeyPrint
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SaveInDb

1 = save document records in DB; otherwise not.

Declaration
public short SaveInDb
Field Value
Type Description
short
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SenderEmailAddress

The email address to use in from field

Declaration
public string SenderEmailAddress
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

SenderEmailMode

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

Declaration
public SenderMailMode SenderEmailMode
Field Value
Type Description
SenderMailMode
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ShowCurrents

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

Declaration
public short ShowCurrents
Field Value
Type Description
short
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Tooltip

Tooltip or other description

Declaration
public string Tooltip
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Updated

Last updated when in UTC.

Declaration
public DateTime Updated
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedAssociateId

Last updated by whom

Declaration
public int UpdatedAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedCount

Number of updates made to this record

Declaration
public short UpdatedCount
Field Value
Type Description
short
Remarks

Please use this class instead of a full DocTmplRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocTmplTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extension Methods