Class NSDocumentTemplateEntity

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.

Syntax

Constructors

NSDocumentTemplateEntity()

Initializes a new instance of the NSDocumentTemplateEntity class.

Declaration

NSDocumentTemplateEntity

Methods

GetAutoeventId()

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

Declaration

Integer GetAutoeventId()

Returns

Type	Description
Integer

Examples

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

GetDefaultOref()

Processed via tag substitution to give document reference

Declaration

String GetDefaultOref()

Returns

Type	Description
String

Examples

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

GetDeleted()

True if deleted

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool

Examples

NSDocumentTemplateEntity thing;
Bool deleted = thing.GetDeleted();

GetDirection()

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.

Declaration

Integer GetDirection()

Returns

Type	Description
Integer	1 = incoming, 2 = outgoing. See TaskDirection

Examples

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

GetDocumentTemplateId()

Primary key

Declaration

Integer GetDocumentTemplateId()

Returns

Type	Description
Integer

Examples

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

GetDocumentTypeKey()

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

Declaration

Integer GetDocumentTypeKey()

Returns

Type	Description
Integer

Examples

NSDocumentTemplateEntity thing;
Integer documentTypeKey = thing.GetDocumentTypeKey();

GetEmailSubject()

Subject to use if document template is an email.

Declaration

String GetEmailSubject()

Returns

Type	Description
String

Examples

NSDocumentTemplateEntity thing;
String emailSubject = thing.GetEmailSubject();

GetFilename()

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

Declaration

String GetFilename()

Returns

Type	Description
String

Examples

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

GetIncludeSignature()

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

Declaration

Bool GetIncludeSignature()

Returns

Type	Description
Bool

Examples

NSDocumentTemplateEntity thing;
Bool includeSignature = thing.GetIncludeSignature();

GetIntentId()

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

Declaration

Integer GetIntentId()

Returns

Type	Description
Integer

Examples

NSDocumentTemplateEntity thing;
Integer intentId = thing.GetIntentId();

GetInvitationDocType()

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.

Declaration

Integer GetInvitationDocType()

Returns

Type	Description
Integer	Type for sending email meeting invitation. See DocTmplInvitationType

Examples

NSDocumentTemplateEntity thing;
Integer invitationDocType = thing.GetInvitationDocType();

GetIsDefaultPublished()

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.

Declaration

Bool GetIsDefaultPublished()

Returns

Type	Description
Bool	Published to external persons.

Examples

NSDocumentTemplateEntity thing;
Bool isDefaultPublished = thing.GetIsDefaultPublished();

GetIsInUseInGuides()

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

Declaration

Bool GetIsInUseInGuides()

Returns

Type	Description
Bool

Examples

NSDocumentTemplateEntity thing;
Bool isInUseInGuides = thing.GetIsInUseInGuides();

GetLoadTemplateFromPlugin()

Which document plugin is responsible for this template's contents

Declaration

Integer GetLoadTemplateFromPlugin()

Returns

Type	Description
Integer

Examples

NSDocumentTemplateEntity thing;
Integer loadTemplateFromPlugin = thing.GetLoadTemplateFromPlugin();

GetMimeType()

The mime type

Declaration

String GetMimeType()

Returns

Type	Description
String

Examples

NSDocumentTemplateEntity thing;
String mimeType = thing.GetMimeType();

GetName()

The template list item

Declaration

String GetName()

Returns

Type	Description
String

Examples

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

GetPrivacyDocType()

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.

Declaration

Integer GetPrivacyDocType()

Returns

Type	Description
Integer	Indicator that this document template has a functional role, related to privacy/GDPR. See DocTmplPrivacyType

Examples

NSDocumentTemplateEntity thing;
Integer privacyDocType = thing.GetPrivacyDocType();

GetQuoteDocType()

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.

Declaration

Integer GetQuoteDocType()

Returns

Type	Description
Integer	The role this document plays in the Quote system, if any. See DocTmplQuoteType

Examples

NSDocumentTemplateEntity thing;
Integer quoteDocType = thing.GetQuoteDocType();

GetRank()

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.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank order.

Examples

NSDocumentTemplateEntity thing;
Integer rank = thing.GetRank();

GetRecordType()

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.

Declaration

NSDocTmplType GetRecordType()

Returns

Type	Description
NSDocTmplType	1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo See TaskType

Examples

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

GetSaveInDb()

1 = save document records in DB; otherwise not.

Declaration

Integer GetSaveInDb()

Returns

Type	Description
Integer

Examples

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

GetSenderEmailAddress()

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

Declaration

String GetSenderEmailAddress()

Returns

Type	Description
String

Examples

NSDocumentTemplateEntity thing;
String senderEmailAddress = thing.GetSenderEmailAddress();

GetSenderEmailMode()

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.

Declaration

Integer GetSenderEmailMode()

Returns

Type	Description
Integer	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. See SenderMailMode

Examples

NSDocumentTemplateEntity thing;
Integer senderEmailMode = thing.GetSenderEmailMode();

GetShowCurrents()

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

Declaration

Bool GetShowCurrents()

Returns

Type	Description
Bool

Examples

NSDocumentTemplateEntity thing;
Bool showCurrents = thing.GetShowCurrents();

GetTooltip()

Tooltip or other description

Declaration

String GetTooltip()

Returns

Type	Description
String

Examples

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

SetAutoeventId(Integer)

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

Declaration

Void SetAutoeventId(Integer autoeventId)

Parameters

Type	Name	Description
Integer	autoeventId

Returns

Type	Description
Void

Examples

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

SetDefaultOref(String)

Processed via tag substitution to give document reference

Declaration

Void SetDefaultOref(String defaultOref)

Parameters

Type	Name	Description
String	defaultOref

Returns

Type	Description
Void

Examples

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

SetDeleted(Bool)

True if deleted

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Bool deleted;
thing.SetDeleted(deleted);

SetDirection(Integer)

Sets the direction of a document template.

Declaration

Void SetDirection(Integer direction)

Parameters

Type	Name	Description
Integer	direction	See TaskDirection.

Returns

Type	Description
Void

Examples

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

SetDocumentTemplateId(Integer)

Primary key

Declaration

Void SetDocumentTemplateId(Integer documentTemplateId)

Parameters

Type	Name	Description
Integer	documentTemplateId

Returns

Type	Description
Void

Examples

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

SetDocumentTypeKey(Integer)

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

Declaration

Void SetDocumentTypeKey(Integer documentTypeKey)

Parameters

Type	Name	Description
Integer	documentTypeKey

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Integer documentTypeKey;
thing.SetDocumentTypeKey(documentTypeKey);

SetEmailSubject(String)

Subject to use if document template is an email.

Declaration

Void SetEmailSubject(String emailSubject)

Parameters

Type	Name	Description
String	emailSubject

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
String emailSubject;
thing.SetEmailSubject(emailSubject);

SetFilename(String)

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

Declaration

Void SetFilename(String filename)

Parameters

Type	Name	Description
String	filename

Returns

Type	Description
Void

Examples

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

SetIncludeSignature(Bool)

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

Declaration

Void SetIncludeSignature(Bool includeSignature)

Parameters

Type	Name	Description
Bool	includeSignature

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Bool includeSignature;
thing.SetIncludeSignature(includeSignature);

SetIntentId(Integer)

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

Declaration

Void SetIntentId(Integer intentId)

Parameters

Type	Name	Description
Integer	intentId

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Integer intentId;
thing.SetIntentId(intentId);

SetInvitationDocType(Integer)

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.

Declaration

Void SetInvitationDocType(Integer invitationDocType)

Parameters

Type	Name	Description
Integer	invitationDocType	The role this document plays in the Quote system, if any. See DocTmplQuoteType.

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Integer invitationDocType;
thing.SetInvitationDocType(invitationDocType);

SetIsDefaultPublished(Bool)

Published to external persons

Declaration

Void SetIsDefaultPublished(Bool isDefaultPublished)

Parameters

Type	Name	Description
Bool	isDefaultPublished

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Bool isDefaultPublished;
thing.SetIsDefaultPublished(isDefaultPublished);

SetIsInUseInGuides(Bool)

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

Declaration

Void SetIsInUseInGuides(Bool isInUseInGuides)

Parameters

Type	Name	Description
Bool	isInUseInGuides

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Bool isInUseInGuides;
thing.SetIsInUseInGuides(isInUseInGuides);

SetLoadTemplateFromPlugin(Integer)

Which document plugin is responsible for this template's contents

Declaration

Void SetLoadTemplateFromPlugin(Integer loadTemplateFromPlugin)

Parameters

Type	Name	Description
Integer	loadTemplateFromPlugin

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Integer loadTemplateFromPlugin;
thing.SetLoadTemplateFromPlugin(loadTemplateFromPlugin);

SetMimeType(String)

The mime type

Declaration

Void SetMimeType(String mimeType)

Parameters

Type	Name	Description
String	mimeType

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
String mimeType;
thing.SetMimeType(mimeType);

SetName(String)

The template list item

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Void

Examples

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

SetPrivacyDocType(Integer)

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.

Declaration

Void SetPrivacyDocType(Integer privacyDocType)

Parameters

Type	Name	Description
Integer	privacyDocType	Indicator that this document template has a functional role, related to privacy/GDPR. See DocTmplPrivacyType.

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Integer privacyDocType;
thing.SetPrivacyDocType(privacyDocType);

SetQuoteDocType(Integer)

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.

Declaration

Void SetQuoteDocType(Integer quoteDocType)

Parameters

Type	Name	Description
Integer	quoteDocType	The role this document plays in the Quote system, if any. See DocTmplQuoteType.

Returns

Type	Description
Void

Examples

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

SetRank(Integer)

Rank order

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Integer rank;
thing.SetRank(rank);

SetRecordType(NSDocTmplType)

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

Declaration

Void SetRecordType(NSDocTmplType recordType)

Parameters

Type	Name	Description
NSDocTmplType	recordType

Returns

Type	Description
Void

Remarks

See TaskType

Examples

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

SetSaveInDb(Integer)

1 = save document records in DB; otherwise not.

Declaration

Void SetSaveInDb(Integer saveInDb)

Parameters

Type	Name	Description
Integer	saveInDb

Returns

Type	Description
Void

Examples

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

SetSenderEmailAddress(String)

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

Declaration

Void SetSenderEmailAddress(String senderEmailAddress)

Parameters

Type	Name	Description
String	senderEmailAddress

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
String senderEmailAddress;
thing.SetSenderEmailAddress(senderEmailAddress);

SetSenderEmailMode(Integer)

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.

Declaration

Void SetSenderEmailMode(Integer senderEmailMode)

Parameters

Type	Name	Description
Integer	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. See SenderMailMode.

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Integer senderEmailMode;
thing.SetSenderEmailMode(senderEmailMode);

SetShowCurrents(Bool)

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

Declaration

Void SetShowCurrents(Bool showCurrents)

Parameters

Type	Name	Description
Bool	showCurrents

Returns

Type	Description
Void

Examples

NSDocumentTemplateEntity thing;
Bool showCurrents;
thing.SetShowCurrents(showCurrents);

SetTooltip(String)

Tooltip or other description

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip

Returns

Type	Description
Void

Examples

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