Class 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.

Carrier object for DocumentTemplateEntity. Services for the DocumentTemplateEntity Carrier is available from the List Agent.
Inheritance
object
DocumentTemplateEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class DocumentTemplateEntity : Carrier
Examples

Get DocumentTemplateEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new ListAgent();
   var documentTemplateEntity = agent.GetDocumentTemplateEntity( 123 );
}

Constructors

DocumentTemplateEntity()

Default constructor

Declaration
public DocumentTemplateEntity()
See Also

Properties

AutoeventId

Which document plugin is responsible for the documents generated from this template

Declaration
[DataMember]
public virtual int AutoeventId { get; set; }
Property Value
Type Description
int
See Also

DefaultOref

Processed via tag substitution to give document reference

Declaration
[DataMember]
public virtual string DefaultOref { get; set; }
Property Value
Type Description
string
See Also

Deleted

True if deleted

Declaration
[DataMember]
public virtual bool Deleted { get; set; }
Property Value
Type Description
bool
See Also

Direction

1 = incoming, 2 = outgoing, see EAppntDirection

Declaration
[DataMember]
public virtual DocTmplDirection Direction { get; set; }
Property Value
Type Description
DocTmplDirection
See Also

DocumentTemplateId

Primary key

Declaration
[DataMember]
public virtual int DocumentTemplateId { get; set; }
Property Value
Type Description
int
See Also

DocumentTypeKey

The document type to use when creating a blank document. Plugin-specific. Used when not creating template from a local file.

Declaration
[DataMember]
public virtual int DocumentTypeKey { get; set; }
Property Value
Type Description
int
See Also

EmailSubject

Subject to use if document template is an email.

Declaration
[DataMember]
public virtual string EmailSubject { get; set; }
Property Value
Type Description
string
See Also

Filename

Relative to TemplatePath, or extref for other document plugins. i.e URL or full path.

Declaration
[DataMember]
public virtual string Filename { get; set; }
Property Value
Type Description
string
See Also

IncludeSignature

True if the email signature should be added in bottom of mail if this an email template

Declaration
[DataMember]
public virtual bool IncludeSignature { get; set; }
Property Value
Type Description
bool
See Also

IntentId

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

Declaration
[DataMember]
public virtual int IntentId { get; set; }
Property Value
Type Description
int
See Also

InvitationDocType

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

Declaration
[DataMember]
public virtual DocTmplInvitationType InvitationDocType { get; set; }
Property Value
Type Description
DocTmplInvitationType
See Also

IsDefaultPublished

Published to external persons

Declaration
[DataMember]
public virtual bool IsDefaultPublished { get; set; }
Property Value
Type Description
bool
See Also

IsInUseInGuides

True if the template is in use in a project or sales guide

Declaration
[DataMember]
public virtual bool IsInUseInGuides { get; set; }
Property Value
Type Description
bool
See Also

LoadTemplateFromPlugin

Which document plugin is responsible for this template's contents

Declaration
[DataMember]
public virtual int LoadTemplateFromPlugin { get; set; }
Property Value
Type Description
int
See Also

MimeType

The mime type

Declaration
[DataMember]
public virtual string MimeType { get; set; }
Property Value
Type Description
string
See Also

Name

The template list item

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also

PrivacyDocType

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

Declaration
[DataMember]
public virtual DocTmplPrivacyType PrivacyDocType { get; set; }
Property Value
Type Description
DocTmplPrivacyType
See Also

QuoteDocType

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

Declaration
[DataMember]
public virtual DocTmplQuoteType QuoteDocType { get; set; }
Property Value
Type Description
DocTmplQuoteType
See Also

Rank

Rank order

Declaration
[DataMember]
public virtual short Rank { get; set; }
Property Value
Type Description
short
See Also

RecordType

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

Declaration
[DataMember]
public virtual DocTmplType RecordType { get; set; }
Property Value
Type Description
DocTmplType
See Also

SaveInDb

1 = save document records in DB; otherwise not.

Declaration
[DataMember]
public virtual short SaveInDb { get; set; }
Property Value
Type Description
short
See Also

SenderEmailAddress

If email template, default senderaddress when template is of type quote email or privacy email.

Declaration
[DataMember]
public virtual string SenderEmailAddress { get; set; }
Property Value
Type Description
string
See Also

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

Declaration
[DataMember]
public virtual SenderMailMode SenderEmailMode { get; set; }
Property Value
Type Description
SenderMailMode
See Also

ShowCurrents

True if when using this template there should be shown a place for editing current choices of person, compant, sale, project etc

Declaration
[DataMember]
public virtual bool ShowCurrents { get; set; }
Property Value
Type Description
bool
See Also

Tooltip

Tooltip or other description

Declaration
[DataMember]
public virtual string Tooltip { get; set; }
Property Value
Type Description
string
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also