NSTemplateVariablesParameters

Parameters specifying source and properties for template variable substitution.

Constructors

NSTemplateVariablesParameters()

NSTemplateVariablesParameters

Initializes a new instance of the NSTemplateVariablesParameters class.

Methods

GetAppointmentId()

Integer GetAppointmentId()

Returns: CRMScript.Global.Integer - Identifier for an appointment. Example:

NSTemplateVariablesParameters thing;
Integer appointmentId = thing.GetAppointmentId();

GetContactId()

Integer GetContactId()

Returns: CRMScript.Global.Integer - Identifier for a contact. Example:

NSTemplateVariablesParameters thing;
Integer contactId = thing.GetContactId();

GetCultureName()

String GetCultureName()

Returns: CRMScript.Global.String - Name of culture to be used for culture-sensitive data, such as dates or multi-language texts.

Use a blank string to accept current culture that is set on the server.

Example:

NSTemplateVariablesParameters thing;
String cultureName = thing.GetCultureName();

GetCustomTags()

String[] GetCustomTags()

Returns: CRMScript.Global.String[] - Array with custom tags and values. Array may be of unlimited height, but need to be exactly 2 in width. Example:

NSTemplateVariablesParameters thing;
String[] customTags = thing.GetCustomTags();

GetDocumentEntity()

NSDocumentEntity GetDocumentEntity()

Returns: CRMScript.NetServer.NSDocumentEntity - Custom document entity to use for data retrieval.

Useful for unsaved data. NSDocumentEntity.DocumentId need to match the DocumentId specified in separate property.

Example:

NSTemplateVariablesParameters thing;
NSDocumentEntity documentEntity = thing.GetDocumentEntity();

GetDocumentId()

Integer GetDocumentId()

Returns: CRMScript.Global.Integer - Identifier for a document. Example:

NSTemplateVariablesParameters thing;
Integer documentId = thing.GetDocumentId();

GetEncoding()

Integer GetEncoding()

Returns: CRMScript.Global.Integer - Encoding of source string. See <xref href=“CRMScript.NetServer.GeneratorEncoding” data-throw-if-not-resolved=“false”></xref>

Non-text formats such as MsWord or Excel should be Base64 encoded in the source string.

Example:

NSTemplateVariablesParameters thing;
Integer encoding = thing.GetEncoding();

GetPersonId()

Integer GetPersonId()

Returns: CRMScript.Global.Integer - Identifier for a person. Example:

NSTemplateVariablesParameters thing;
Integer personId = thing.GetPersonId();

GetProductKey()

String GetProductKey()

Returns: CRMScript.Global.String - Product key. Example:

NSTemplateVariablesParameters thing;
String productKey = thing.GetProductKey();

GetProjectId()

Integer GetProjectId()

Returns: CRMScript.Global.Integer - Identifier for a project. Example:

NSTemplateVariablesParameters thing;
Integer projectId = thing.GetProjectId();

GetQuoteAlternativeId()

Integer GetQuoteAlternativeId()

Returns: CRMScript.Global.Integer - Quote alternative Id. Example:

NSTemplateVariablesParameters thing;
Integer quoteAlternativeId = thing.GetQuoteAlternativeId();

GetQuoteLineId()

Integer GetQuoteLineId()

Returns: CRMScript.Global.Integer - Quote line Id. Example:

NSTemplateVariablesParameters thing;
Integer quoteLineId = thing.GetQuoteLineId();

GetSaleId()

Integer GetSaleId()

Returns: CRMScript.Global.Integer - Identifier for a sale. Example:

NSTemplateVariablesParameters thing;
Integer saleId = thing.GetSaleId();

GetSelectionId()

Integer GetSelectionId()

Returns: CRMScript.Global.Integer - Identifier for a selection. Example:

NSTemplateVariablesParameters thing;
Integer selectionId = thing.GetSelectionId();

GetSourceInput()

String GetSourceInput()

Returns: CRMScript.Global.String - Source string to parse for template variables.

Such variables must have delimiters corresponding to the standard for the given generator encoding.Non-text source data (such as the binary content of a .doc file) should be passed in as Base64.

Example:

NSTemplateVariablesParameters thing;
String sourceInput = thing.GetSourceInput();

SetAppointmentId(Integer)

Void SetAppointmentId(Integer appointmentId)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
Integer appointmentId;
thing.SetAppointmentId(appointmentId);

SetContactId(Integer)

Void SetContactId(Integer contactId)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
Integer contactId;
thing.SetContactId(contactId);

SetCultureName(String)

Void SetCultureName(String cultureName)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
String cultureName;
thing.SetCultureName(cultureName);

SetCustomTags(String[])

Void SetCustomTags(String[] customTags)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
String[] customTags;
thing.SetCustomTags(customTags);

SetDocumentEntity(NSDocumentEntity)

Void SetDocumentEntity(NSDocumentEntity documentEntity)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
NSDocumentEntity documentEntity;
thing.SetDocumentEntity(documentEntity);

SetDocumentId(Integer)

Void SetDocumentId(Integer documentId)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
Integer documentId;
thing.SetDocumentId(documentId);

SetEncoding(Integer)

Void SetEncoding(Integer encoding)

Returns: CRMScript.Global.Void

Non-text formats such as MsWord or Excel should be Base64 encoded in the source string.

Example:

NSTemplateVariablesParameters thing;
Integer encoding;
thing.SetEncoding(encoding);

SetPersonId(Integer)

Void SetPersonId(Integer personId)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
Integer personId;
thing.SetPersonId(personId);

SetProductKey(String)

Void SetProductKey(String productKey)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
String productKey;
thing.SetProductKey(productKey);

SetProjectId(Integer)

Void SetProjectId(Integer projectId)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
Integer projectId;
thing.SetProjectId(projectId);

SetQuoteAlternativeId(Integer)

Void SetQuoteAlternativeId(Integer quoteAlternativeId)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
Integer quoteAlternativeId;
thing.SetQuoteAlternativeId(quoteAlternativeId);

SetQuoteLineId(Integer)

Void SetQuoteLineId(Integer quoteLineId)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
Integer quoteLineId;
thing.SetQuoteLineId(quoteLineId);

SetSaleId(Integer)

Void SetSaleId(Integer saleId)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
Integer saleId;
thing.SetSaleId(saleId);

SetSelectionId(Integer)

Void SetSelectionId(Integer selectionId)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
Integer selectionId;
thing.SetSelectionId(selectionId);

SetSourceInput(String)

Void SetSourceInput(String sourceInput)

Returns: CRMScript.Global.Void Example:

NSTemplateVariablesParameters thing;
String sourceInput;
thing.SetSourceInput(sourceInput);

​Constructors

​NSTemplateVariablesParameters()

​Methods

​GetAppointmentId()

​GetContactId()

​GetCultureName()

​GetCustomTags()

​GetDocumentEntity()

​GetDocumentId()

​GetEncoding()

​GetPersonId()

​GetProductKey()

​GetProjectId()

​GetQuoteAlternativeId()

​GetQuoteLineId()

​GetSaleId()

​GetSelectionId()

​GetSourceInput()

​SetAppointmentId(Integer)

​SetContactId(Integer)

​SetCultureName(String)

​SetCustomTags(String[])

​SetDocumentEntity(NSDocumentEntity)

​SetDocumentId(Integer)

​SetEncoding(Integer)

​SetPersonId(Integer)

​SetProductKey(String)

​SetProjectId(Integer)

​SetQuoteAlternativeId(Integer)

​SetQuoteLineId(Integer)

​SetSaleId(Integer)

​SetSelectionId(Integer)

​SetSourceInput(String)

Constructors

NSTemplateVariablesParameters()

Methods

GetAppointmentId()

GetContactId()

GetCultureName()

GetCustomTags()

GetDocumentEntity()

GetDocumentId()

GetEncoding()

GetPersonId()

GetProductKey()

GetProjectId()

GetQuoteAlternativeId()

GetQuoteLineId()

GetSaleId()

GetSelectionId()

GetSourceInput()

SetAppointmentId(Integer)

SetContactId(Integer)

SetCultureName(String)

SetCustomTags(String[])

SetDocumentEntity(NSDocumentEntity)

SetDocumentId(Integer)

SetEncoding(Integer)

SetPersonId(Integer)

SetProductKey(String)

SetProjectId(Integer)

SetQuoteAlternativeId(Integer)

SetQuoteLineId(Integer)

SetSaleId(Integer)

SetSelectionId(Integer)

SetSourceInput(String)