Class DocumentTemplate
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for 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.
Inheritance
object ←
Carrier ←
DocumentTemplate
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 DocumentTemplate 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var documentTemplate = agent.GetDocumentTemplate( 123 );
Constructors
DocumentTemplate()
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
0 -> record is active 1 -> record is ‘deleted’ and should not be shown in lists
Property Value
short
Direction
1 = incoming, 2 = outgoing, see EAppntDirection
NULL if unknown enum value.
Property Value
DocTmplDirection?
See Also
DocumentTemplate.Direction_String
Direction_String
1 = incoming, 2 = outgoing, see EAppntDirection
Raw string enum value.
Property Value
string
See Also
DocumentTemplate.Direction
DocumentTemplateId
Primary key
Property Value
int
Filename
Relative to TemplatePath
Property Value
string
Name
The list item
Property Value
string
QuoteDocType
What type of quote document is this.
NULL if unknown enum value.
Property Value
DocTmplQuoteType?
See Also
DocumentTemplate.QuoteDocType_String
QuoteDocType_String
What type of quote document is this.
Raw string enum value.
Property Value
string
See Also
DocumentTemplate.QuoteDocType
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
DocumentTemplate.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
DocumentTemplate.RecordType
SaveInDb
1 = save document records in DB; otherwise not.
Property Value
short
Tooltip or other description
Property Value
string
See Also
ListAgent
