Class DocumentTemplateEntity
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for DocumentTemplateEntity.
The template a document is based on is stored in the SO_arc\template folder on the server. This will return the name as displayed in the GUI, and not the physical document name, of the template the document object is based on.
Inheritance
object ←
Carrier ←
DocumentTemplateEntity
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get DocumentTemplateEntity 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var documentTemplateEntity = agent.GetDocumentTemplateEntity( 123 );
Constructors
DocumentTemplateEntity()
Default constructor - defaults any enum props to 0.
Properties
AutoeventId
Which document plugin is responsible for the documents generated from this template
Property Value
int
DefaultOref
Processed via tag substitution to give document reference
Property Value
string
Deleted
True if deleted
Property Value
bool
Direction
1 = incoming, 2 = outgoing, see EAppntDirection
NULL if unknown enum value.
Property Value
DocTmplDirection?
See Also
DocumentTemplateEntity.Direction_String
Direction_String
1 = incoming, 2 = outgoing, see EAppntDirection
Raw string enum value.
Property Value
string
See Also
DocumentTemplateEntity.Direction
DocumentTemplateId
Primary key
Property Value
int
DocumentTypeKey
The document type to use when creating a blank document. Plugin-specific. Used when not creating template from a local file.
Property Value
int
EmailSubject
Subject to use if document template is an email.
Property Value
string
Filename
Relative to TemplatePath, or extref for other document plugins. i.e URL or full path.
Property Value
string
IncludeSignature
True if the email signature should be added in bottom of mail if this an email template
Property Value
bool
IntentId
What is the intention of this document (used by SAINT)
Property Value
int
InvitationDocType
Type for sending email meeting invitation. Not an invitation type template = 0, New = 1, Changed = 2, Cancelled = 3
NULL if unknown enum value.
Property Value
DocTmplInvitationType?
See Also
DocumentTemplateEntity.InvitationDocType_String
InvitationDocType_String
Type for sending email meeting invitation. Not an invitation type template = 0, New = 1, Changed = 2, Cancelled = 3
Raw string enum value.
Property Value
string
See Also
DocumentTemplateEntity.InvitationDocType
IsDefaultPublished
Published to external persons
Property Value
bool
IsInUseInGuides
True if the template is in use in a project or sales guide
Property Value
bool
LoadTemplateFromPlugin
Which document plugin is responsible for this template’s contents
Property Value
int
MimeType
The mime type
Property Value
string
Name
The template list item
Property Value
string
PrivacyDocType
Indicator that this document template has a functional role, related to privacy/GDPR
NULL if unknown enum value.
Property Value
DocTmplPrivacyType?
See Also
DocumentTemplateEntity.PrivacyDocType_String
PrivacyDocType_String
Indicator that this document template has a functional role, related to privacy/GDPR
Raw string enum value.
Property Value
string
See Also
DocumentTemplateEntity.PrivacyDocType
QuoteDocType
The role this document plays in the Quote system, if any
NULL if unknown enum value.
Property Value
DocTmplQuoteType?
See Also
DocumentTemplateEntity.QuoteDocType_String
QuoteDocType_String
The role this document plays in the Quote system, if any
Raw string enum value.
Property Value
string
See Also
DocumentTemplateEntity.QuoteDocType
Rank
Rank order
Property Value
short
RecordType
1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes
NULL if unknown enum value.
Property Value
DocTmplType?
See Also
DocumentTemplateEntity.RecordType_String
RecordType_String
1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes
Raw string enum value.
Property Value
string
See Also
DocumentTemplateEntity.RecordType
SaveInDb
1 = save document records in DB; otherwise not.
Property Value
short
SenderEmailAddress
If email template, default senderaddress when template is of type quote email or privacy email.
Property Value
string
SenderEmailMode
If email template, when DocType is Privacy or quote email, it is possible to make sender address like our contact, or our support contact, or always one address
NULL if unknown enum value.
Property Value
SenderMailMode?
See Also
DocumentTemplateEntity.SenderEmailMode_String
SenderEmailMode_String
If email template, when DocType is Privacy or quote email, it is possible to make sender address like our contact, or our support contact, or always one address
Raw string enum value.
Property Value
string
See Also
DocumentTemplateEntity.SenderEmailMode
ShowCurrents
True if when using this template there should be shown a place for editing current choices of person, compant, sale, project etc
Property Value
bool
Tooltip or other description
Property Value
string
See Also
ListAgent
