Class DocumentTemplate

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 DocumentTemplate. Services for the DocumentTemplate Carrier is available from the IListAgent.
Inheritance
Object
DocumentTemplate
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class DocumentTemplate : Carrier
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

DocumentTemplate()

Default constructor

Declaration
public DocumentTemplate()
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

Properties

AutoeventId

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

Declaration
public virtual int AutoeventId { get; set; }
Property Value
Type Description
Int32
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

DefaultOref

Processed via tag substitution to give document reference

Declaration
public virtual string DefaultOref { get; set; }
Property Value
Type Description
String
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

Deleted

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

Declaration
public virtual short Deleted { get; set; }
Property Value
Type Description
Int16
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

Direction

1 = incoming, 2 = outgoing, see EAppntDirection

Declaration
public virtual DocTmplDirection Direction { get; set; }
Property Value
Type Description
DocTmplDirection
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

DocumentTemplateId

Primary key

Declaration
public virtual int DocumentTemplateId { get; set; }
Property Value
Type Description
Int32
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

Filename

Relative to TemplatePath

Declaration
public virtual string Filename { get; set; }
Property Value
Type Description
String
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

Name

The list item

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

QuoteDocType

What type of quote document is this.

Declaration
public virtual DocTmplQuoteType QuoteDocType { get; set; }
Property Value
Type Description
DocTmplQuoteType
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

RecordType

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

Declaration
public virtual DocTmplType RecordType { get; set; }
Property Value
Type Description
DocTmplType
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

SaveInDb

1 = save document records in DB; otherwise not.

Declaration
public virtual short SaveInDb { get; set; }
Property Value
Type Description
Int16
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

Tooltip

Tooltip or other description

Declaration
public virtual string Tooltip { get; set; }
Property Value
Type Description
String
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
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.
Examples

Get DocumentTemplate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var documentTemplate = agent.GetDocumentTemplate( 123 );
 }
See Also

See Also