NSDocumentTemplate - SuperOffice

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.

Constructors

NSDocumentTemplate()

NSDocumentTemplate

Initializes a new instance of the NSDocumentTemplate class.

Methods

GetAutoeventId()

Integer GetAutoeventId()

Returns: CRMScript.Global.Integer - Which document plugin is responsible for the documents generated from this template. Example:

NSDocumentTemplate thing;
Integer autoeventId = thing.GetAutoeventId();

GetDefaultOref()

String GetDefaultOref()

Returns: CRMScript.Global.String - Processed via tag substitution to give document reference. Example:

NSDocumentTemplate thing;
String defaultOref = thing.GetDefaultOref();

GetDeleted()

Integer GetDeleted()

Returns: CRMScript.Global.Integer - 0 -> record is active 1 -> record is ‘deleted’ and should not be shown in lists. Example:

NSDocumentTemplate thing;
Integer deleted = thing.GetDeleted();

GetDirection()

Integer GetDirection()

Returns: CRMScript.Global.Integer - 1 = incoming, 2 = outgoing. See <xref href=“CRMScript.NetServer.TaskDirection” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentTemplate thing;
Integer direction = thing.GetDirection();

GetDocumentTemplateId()

Integer GetDocumentTemplateId()

Returns: CRMScript.Global.Integer - Primary key. Example:

NSDocumentTemplate thing;
Integer documentTemplateId = thing.GetDocumentTemplateId();

GetFilename()

String GetFilename()

Returns: CRMScript.Global.String - Relative to TemplatePath. Example:

NSDocumentTemplate thing;
String filename = thing.GetFilename();

GetName()

String GetName()

Returns: CRMScript.Global.String - The list item. Example:

NSDocumentTemplate thing;
String name = thing.GetName();

GetQuoteDocType()

Integer GetQuoteDocType()

Returns: CRMScript.Global.Integer - What type of quote document is this? See <xref href=“CRMScript.NetServer.DocTmplQuoteType” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentTemplate thing;
NSDocTmplQuoteType quoteDocType = thing.GetQuoteDocType();

GetRecordType()

NSDocTmplType GetRecordType()

Returns: CRMScript.NetServer.NSDocTmplType - 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo See <xref href=“CRMScript.NetServer.TaskType” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentTemplate thing;
NSDocTmplType recordType = thing.GetRecordType();

GetSaveInDb()

Integer GetSaveInDb()

Returns: CRMScript.Global.Integer - 1 = save document records in DB; otherwise not. Example:

NSDocumentTemplate thing;
Integer saveInDb = thing.GetSaveInDb();

GetTooltip()

String GetTooltip()

Returns: CRMScript.Global.String - Tooltip or other description. Example:

NSDocumentTemplate thing;
String tooltip = thing.GetTooltip();

SetAutoeventId(Integer)

Void SetAutoeventId(Integer autoeventId)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
Integer autoeventId;
thing.SetAutoeventId(autoeventId);

SetDefaultOref(String)

Void SetDefaultOref(String defaultOref)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
String defaultOref;
thing.SetDefaultOref(defaultOref);

SetDeleted(Integer)

Void SetDeleted(Integer deleted)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
Integer deleted;
thing.SetDeleted(deleted);

SetDirection(Integer)

Sets the direction of a document template

Void SetDirection(Integer direction)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
Integer direction;
thing.SetDirection(direction);

SetDocumentTemplateId(Integer)

Void SetDocumentTemplateId(Integer documentTemplateId)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
Integer documentTemplateId;
thing.SetDocumentTemplateId(documentTemplateId);

SetFilename(String)

Void SetFilename(String filename)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
String filename;
thing.SetFilename(filename);

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
String name;
thing.SetName(name);

SetQuoteDocType(Integer)

Void SetQuoteDocType(Integer quoteDocType)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
Integer quoteDocType;
thing.SetQuoteDocType(quoteDocType);

SetRecordType(NSDocTmplType)

Void SetRecordType(NSDocTmplType recordType)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
NSDocTmplType recordType;
thing.SetRecordType(recordType);

SetSaveInDb(Integer)

Void SetSaveInDb(Integer saveInDb)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
Integer saveInDb;
thing.SetSaveInDb(saveInDb);

SetTooltip(String)

Void SetTooltip(String tooltip)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplate thing;
String tooltip;
thing.SetTooltip(tooltip);

​Constructors

​NSDocumentTemplate()

​Methods

​GetAutoeventId()

​GetDefaultOref()

​GetDeleted()

​GetDirection()

​GetDocumentTemplateId()

​GetFilename()

​GetName()

​GetQuoteDocType()

​GetRecordType()

​GetSaveInDb()

​GetTooltip()

​SetAutoeventId(Integer)

​SetDefaultOref(String)

​SetDeleted(Integer)

​SetDirection(Integer)

​SetDocumentTemplateId(Integer)

​SetFilename(String)

​SetName(String)

​SetQuoteDocType(Integer)

​SetRecordType(NSDocTmplType)

​SetSaveInDb(Integer)

​SetTooltip(String)

Constructors

NSDocumentTemplate()

Methods

GetAutoeventId()

GetDefaultOref()

GetDeleted()

GetDirection()

GetDocumentTemplateId()

GetFilename()

GetName()

GetQuoteDocType()

GetRecordType()

GetSaveInDb()

GetTooltip()

SetAutoeventId(Integer)

SetDefaultOref(String)

SetDeleted(Integer)

SetDirection(Integer)

SetDocumentTemplateId(Integer)

SetFilename(String)

SetName(String)

SetQuoteDocType(Integer)

SetRecordType(NSDocTmplType)

SetSaveInDb(Integer)

SetTooltip(String)