Class NSDocumentTemplate

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()

Initializes a new instance of the NSDocumentTemplate class.

Declaration

NSDocumentTemplate

Methods

GetAutoeventId()

Declaration

Integer GetAutoeventId()

Examples

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

Returns

Type Description
Integer Which document plugin is responsible for the documents generated from this template.

GetDefaultOref()

Declaration

String GetDefaultOref()

Examples

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

Returns

Type Description
String Processed via tag substitution to give document reference.

GetDeleted()

Declaration

Integer GetDeleted()

Examples

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

Returns

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

GetDirection()

Declaration

Integer GetDirection()

Examples

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

Returns

Type Description
Integer 1 = incoming, 2 = outgoing. See <xref href="CRMScript.NetServer.TaskDirection" data-throw-if-not-resolved="false"></xref>

GetDocumentTemplateId()

Declaration

Integer GetDocumentTemplateId()

Examples

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

Returns

Type Description
Integer Primary key.

GetFilename()

Declaration

String GetFilename()

Examples

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

Returns

Type Description
String Relative to TemplatePath.

GetName()

Declaration

String GetName()

Examples

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

Returns

Type Description
String The list item.

GetQuoteDocType()

Declaration

Integer GetQuoteDocType()

Examples

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

Returns

Type Description
Integer What type of quote document is this? See <xref href="CRMScript.NetServer.DocTmplQuoteType" data-throw-if-not-resolved="false"></xref>

GetRecordType()

Declaration

NSDocTmplType GetRecordType()

Examples

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

Returns

Type Description
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>

GetSaveInDb()

Declaration

Integer GetSaveInDb()

Examples

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

Returns

Type Description
Integer 1 = save document records in DB; otherwise not.

GetTooltip()

Declaration

String GetTooltip()

Examples

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

Returns

Type Description
String Tooltip or other description.

SetAutoeventId(Integer)

Declaration

Void SetAutoeventId(Integer autoeventId)

Examples

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

Parameters

Type Name Description
Integer autoeventId Which document plugin is responsible for the documents generated from this template.

Returns

Type Description
Void

SetDefaultOref(String)

Declaration

Void SetDefaultOref(String defaultOref)

Examples

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

Parameters

Type Name Description
String defaultOref Processed via tag substitution to give document reference.

Returns

Type Description
Void

SetDeleted(Integer)

Declaration

Void SetDeleted(Integer deleted)

Examples

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

Parameters

Type Name Description
Integer deleted 0 -&gt; record is active 1 -&gt; record is 'deleted' and should not be shown in lists.

Returns

Type Description
Void

SetDirection(Integer)

Sets the direction of a document template

Declaration

Void SetDirection(Integer direction)

Examples

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

Parameters

Type Name Description
Integer direction The direction of documents from this template. See <xref href="CRMScript.NetServer.TaskDirection" data-throw-if-not-resolved="false"></xref>.

Returns

Type Description
Void

SetDocumentTemplateId(Integer)

Declaration

Void SetDocumentTemplateId(Integer documentTemplateId)

Examples

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

Parameters

Type Name Description
Integer documentTemplateId Primary key.

Returns

Type Description
Void

SetFilename(String)

Declaration

Void SetFilename(String filename)

Examples

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

Parameters

Type Name Description
String filename Relative to TemplatePath.

Returns

Type Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

Type Name Description
String name The list item.

Returns

Type Description
Void

SetQuoteDocType(Integer)

Declaration

Void SetQuoteDocType(Integer quoteDocType)

Examples

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

Parameters

Type Name Description
Integer quoteDocType What type of quote document is this? See <xref href="CRMScript.NetServer.DocTmplQuoteType" data-throw-if-not-resolved="false"></xref>.

Returns

Type Description
Void

SetRecordType(NSDocTmplType)

Declaration

Void SetRecordType(NSDocTmplType recordType)

Examples

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

Parameters

Type Name Description
NSDocTmplType recordType 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>.

Returns

Type Description
Void

SetSaveInDb(Integer)

Declaration

Void SetSaveInDb(Integer saveInDb)

Examples

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

Parameters

Type Name Description
Integer saveInDb 1 = save document records in DB; otherwise not.

Returns

Type Description
Void

SetTooltip(String)

Declaration

Void SetTooltip(String tooltip)

Examples

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

Parameters

Type Name Description
String tooltip Tooltip or other description.

Returns

Type Description
Void