Class NSTemplateVariablesParameters
Parameters specifying source and properties for template variable substitution.
Constructors
NSTemplateVariablesParameters()
Initializes a new instance of the NSTemplateVariablesParameters class.
Declaration
NSTemplateVariablesParametersMethods
GetAppointmentId()
Declaration
Integer GetAppointmentId()Examples
NSTemplateVariablesParameters thing;
Integer appointmentId = thing.GetAppointmentId();Returns
| Type | Description |
| Integer | Identifier for an appointment. |
GetContactId()
Declaration
Integer GetContactId()Examples
NSTemplateVariablesParameters thing;
Integer contactId = thing.GetContactId();Returns
| Type | Description |
| Integer | Identifier for a contact. |
GetCultureName()
Declaration
String GetCultureName()Examples
NSTemplateVariablesParameters thing;
String cultureName = thing.GetCultureName();Returns
| Type | Description |
| String | Name of culture to be used for culture-sensitive data, such as dates or multi-language texts. |
GetCustomTags()
Declaration
String[] GetCustomTags()Examples
NSTemplateVariablesParameters thing;
String[] customTags = thing.GetCustomTags();Returns
| Type | Description |
| String[] | Array with custom tags and values. Array may be of unlimited height, but need to be exactly 2 in width. |
GetDocumentEntity()
Declaration
NSDocumentEntity GetDocumentEntity()Examples
NSTemplateVariablesParameters thing;
NSDocumentEntity documentEntity = thing.GetDocumentEntity();Returns
| Type | Description |
| NSDocumentEntity | Custom document entity to use for data retrieval. |
GetDocumentId()
Declaration
Integer GetDocumentId()Examples
NSTemplateVariablesParameters thing;
Integer documentId = thing.GetDocumentId();Returns
| Type | Description |
| Integer | Identifier for a document. |
GetEncoding()
Declaration
Integer GetEncoding()Examples
NSTemplateVariablesParameters thing;
Integer encoding = thing.GetEncoding();Returns
| Type | Description |
| Integer | Encoding of source string. See <xref href="CRMScript.NetServer.GeneratorEncoding" data-throw-if-not-resolved="false"></xref> |
GetPersonId()
Declaration
Integer GetPersonId()Examples
NSTemplateVariablesParameters thing;
Integer personId = thing.GetPersonId();Returns
| Type | Description |
| Integer | Identifier for a person. |
GetProductKey()
Declaration
String GetProductKey()Examples
NSTemplateVariablesParameters thing;
String productKey = thing.GetProductKey();Returns
| Type | Description |
| String | Product key. |
GetProjectId()
Declaration
Integer GetProjectId()Examples
NSTemplateVariablesParameters thing;
Integer projectId = thing.GetProjectId();Returns
| Type | Description |
| Integer | Identifier for a project. |
GetQuoteAlternativeId()
Declaration
Integer GetQuoteAlternativeId()Examples
NSTemplateVariablesParameters thing;
Integer quoteAlternativeId = thing.GetQuoteAlternativeId();Returns
| Type | Description |
| Integer | Quote alternative Id. |
GetQuoteLineId()
Declaration
Integer GetQuoteLineId()Examples
NSTemplateVariablesParameters thing;
Integer quoteLineId = thing.GetQuoteLineId();Returns
| Type | Description |
| Integer | Quote line Id. |
GetSaleId()
Declaration
Integer GetSaleId()Examples
NSTemplateVariablesParameters thing;
Integer saleId = thing.GetSaleId();Returns
| Type | Description |
| Integer | Identifier for a sale. |
GetSelectionId()
Declaration
Integer GetSelectionId()Examples
NSTemplateVariablesParameters thing;
Integer selectionId = thing.GetSelectionId();Returns
| Type | Description |
| Integer | Identifier for a selection. |
GetSourceInput()
Declaration
String GetSourceInput()Examples
NSTemplateVariablesParameters thing;
String sourceInput = thing.GetSourceInput();Returns
| Type | Description |
| String | Source string to parse for template variables. |
SetAppointmentId(Integer)
Declaration
Void SetAppointmentId(Integer appointmentId)Examples
NSTemplateVariablesParameters thing;
Integer appointmentId;
thing.SetAppointmentId(appointmentId);Parameters
| Type | Name | Description |
| Integer | appointmentId | Identifier for an appointment. |
Returns
| Type | Description |
| Void |
SetContactId(Integer)
Declaration
Void SetContactId(Integer contactId)Examples
NSTemplateVariablesParameters thing;
Integer contactId;
thing.SetContactId(contactId);Parameters
| Type | Name | Description |
| Integer | contactId | Identifier for a contact. |
Returns
| Type | Description |
| Void |
SetCultureName(String)
Declaration
Void SetCultureName(String cultureName)Examples
NSTemplateVariablesParameters thing;
String cultureName;
thing.SetCultureName(cultureName);Parameters
| Type | Name | Description |
| String | cultureName | 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. |
Returns
| Type | Description |
| Void |
SetCustomTags(String[])
Declaration
Void SetCustomTags(String[] customTags)Examples
NSTemplateVariablesParameters thing;
String[] customTags;
thing.SetCustomTags(customTags);Parameters
| Type | Name | Description |
| String[] | customTags | Array with custom tags and values. Array may be of unlimited height, but need to be exactly 2 in width. |
Returns
| Type | Description |
| Void |
SetDocumentEntity(NSDocumentEntity)
Declaration
Void SetDocumentEntity(NSDocumentEntity documentEntity)Examples
NSTemplateVariablesParameters thing;
NSDocumentEntity documentEntity;
thing.SetDocumentEntity(documentEntity);Parameters
| Type | Name | Description |
| NSDocumentEntity | documentEntity | Custom document entity to use for data retrieval. Useful for unsaved data. NSDocumentEntity.DocumentId need to match the DocumentId specified in separate property. |
Returns
| Type | Description |
| Void |
SetDocumentId(Integer)
Declaration
Void SetDocumentId(Integer documentId)Examples
NSTemplateVariablesParameters thing;
Integer documentId;
thing.SetDocumentId(documentId);Parameters
| Type | Name | Description |
| Integer | documentId | Identifier for a document. |
Returns
| Type | Description |
| Void |
SetEncoding(Integer)
Declaration
Void SetEncoding(Integer encoding)Examples
NSTemplateVariablesParameters thing;
Integer encoding;
thing.SetEncoding(encoding);Parameters
| Type | Name | Description |
| Integer | encoding | Encoding of source string. See <xref href="CRMScript.NetServer.GeneratorEncoding" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetPersonId(Integer)
Declaration
Void SetPersonId(Integer personId)Examples
NSTemplateVariablesParameters thing;
Integer personId;
thing.SetPersonId(personId);Parameters
| Type | Name | Description |
| Integer | personId | Identifier for a person. |
Returns
| Type | Description |
| Void |
SetProductKey(String)
Declaration
Void SetProductKey(String productKey)Examples
NSTemplateVariablesParameters thing;
String productKey;
thing.SetProductKey(productKey);Parameters
| Type | Name | Description |
| String | productKey | Product key. |
Returns
| Type | Description |
| Void |
SetProjectId(Integer)
Declaration
Void SetProjectId(Integer projectId)Examples
NSTemplateVariablesParameters thing;
Integer projectId;
thing.SetProjectId(projectId);Parameters
| Type | Name | Description |
| Integer | projectId | Identifier for a project. |
Returns
| Type | Description |
| Void |
SetQuoteAlternativeId(Integer)
Declaration
Void SetQuoteAlternativeId(Integer quoteAlternativeId)Examples
NSTemplateVariablesParameters thing;
Integer quoteAlternativeId;
thing.SetQuoteAlternativeId(quoteAlternativeId);Parameters
| Type | Name | Description |
| Integer | quoteAlternativeId | Quote alternative Id. |
Returns
| Type | Description |
| Void |
SetQuoteLineId(Integer)
Declaration
Void SetQuoteLineId(Integer quoteLineId)Examples
NSTemplateVariablesParameters thing;
Integer quoteLineId;
thing.SetQuoteLineId(quoteLineId);Parameters
| Type | Name | Description |
| Integer | quoteLineId | Quote line Id. |
Returns
| Type | Description |
| Void |
SetSaleId(Integer)
Declaration
Void SetSaleId(Integer saleId)Examples
NSTemplateVariablesParameters thing;
Integer saleId;
thing.SetSaleId(saleId);Parameters
| Type | Name | Description |
| Integer | saleId | Identifier for a sale. |
Returns
| Type | Description |
| Void |
SetSelectionId(Integer)
Declaration
Void SetSelectionId(Integer selectionId)Examples
NSTemplateVariablesParameters thing;
Integer selectionId;
thing.SetSelectionId(selectionId);Parameters
| Type | Name | Description |
| Integer | selectionId | Identifier for a selection. |
Returns
| Type | Description |
| Void |
SetSourceInput(String)
Declaration
Void SetSourceInput(String sourceInput)Examples
NSTemplateVariablesParameters thing;
String sourceInput;
thing.SetSourceInput(sourceInput);Parameters
| Type | Name | Description |
| String | sourceInput | 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. |
Returns
| Type | Description |
| Void |