Class NSTemplateVariablesParameters

Parameters specifying source and properties for template variable substitution.

Syntax

Constructors

NSTemplateVariablesParameters()

Initializes a new instance of the NSTemplateVariablesParameters class.

Declaration

NSTemplateVariablesParameters

Methods

GetAppointmentId()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetAppointmentId()

Returns

Type	Description
Integer	Identifier for an appointment.

Examples

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

GetContactId()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetContactId()

Returns

Type	Description
Integer	Identifier for a contact.

Examples

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

GetCultureName()

Parameters specifying source and properties for template variable substitution.

Declaration

String GetCultureName()

Returns

Type	Description
String	Name of culture to be used for culture-sensitive data, such as dates or multi-language texts.

Remarks

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

Examples

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

GetCustomTags()

Parameters specifying source and properties for template variable substitution.

Declaration

String[] 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.

Examples

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

GetDocumentEntity()

Parameters specifying source and properties for template variable substitution.

Declaration

NSDocumentEntity GetDocumentEntity()

Returns

Type	Description
NSDocumentEntity	Custom document entity to use for data retrieval.

Remarks

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

Examples

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

GetDocumentId()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetDocumentId()

Returns

Type	Description
Integer	Identifier for a document.

Examples

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

GetEncoding()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetEncoding()

Returns

Type	Description
Integer	Encoding of source string. See GeneratorEncoding

Remarks

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

Examples

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

GetPersonId()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetPersonId()

Returns

Type	Description
Integer	Identifier for a person.

Examples

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

GetProductKey()

Parameters specifying source and properties for template variable substitution.

Declaration

String GetProductKey()

Returns

Type	Description
String	Product key.

Examples

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

GetProjectId()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetProjectId()

Returns

Type	Description
Integer	Identifier for a project.

Examples

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

GetQuoteAlternativeId()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetQuoteAlternativeId()

Returns

Type	Description
Integer	Quote alternative Id.

Examples

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

GetQuoteLineId()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetQuoteLineId()

Returns

Type	Description
Integer	Quote line Id.

Examples

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

GetSaleId()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetSaleId()

Returns

Type	Description
Integer	Identifier for a sale.

Examples

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

GetSelectionId()

Parameters specifying source and properties for template variable substitution.

Declaration

Integer GetSelectionId()

Returns

Type	Description
Integer	Identifier for a selection.

Examples

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

GetSourceInput()

Parameters specifying source and properties for template variable substitution.

Declaration

String GetSourceInput()

Returns

Type	Description
String	Source string to parse for template variables.

Remarks

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.

Examples

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

SetAppointmentId(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetAppointmentId(Integer appointmentId)

Parameters

Type	Name	Description
Integer	appointmentId	Identifier for an appointment.

Returns

Type	Description
Void

Examples

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

SetContactId(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetContactId(Integer contactId)

Parameters

Type	Name	Description
Integer	contactId	Identifier for a contact.

Returns

Type	Description
Void

Examples

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

SetCultureName(String)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetCultureName(String 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

Examples

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

SetCustomTags(String[])

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetCustomTags(String[] 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

Examples

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

SetDocumentEntity(NSDocumentEntity)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetDocumentEntity(NSDocumentEntity 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

Examples

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

SetDocumentId(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetDocumentId(Integer documentId)

Parameters

Type	Name	Description
Integer	documentId	Identifier for a document.

Returns

Type	Description
Void

Examples

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

SetEncoding(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetEncoding(Integer encoding)

Parameters

Type	Name	Description
Integer	encoding	Encoding of source string. See GeneratorEncoding.

Returns

Type	Description
Void

Remarks

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

Examples

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

SetPersonId(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetPersonId(Integer personId)

Parameters

Type	Name	Description
Integer	personId	Identifier for a person.

Returns

Type	Description
Void

Examples

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

SetProductKey(String)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetProductKey(String productKey)

Parameters

Type	Name	Description
String	productKey	Product key.

Returns

Type	Description
Void

Examples

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

SetProjectId(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetProjectId(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId	Identifier for a project.

Returns

Type	Description
Void

Examples

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

SetQuoteAlternativeId(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetQuoteAlternativeId(Integer quoteAlternativeId)

Parameters

Type	Name	Description
Integer	quoteAlternativeId	Quote alternative Id.

Returns

Type	Description
Void

Examples

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

SetQuoteLineId(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetQuoteLineId(Integer quoteLineId)

Parameters

Type	Name	Description
Integer	quoteLineId	Quote line Id.

Returns

Type	Description
Void

Examples

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

SetSaleId(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetSaleId(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId	Identifier for a sale.

Returns

Type	Description
Void

Examples

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

SetSelectionId(Integer)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetSelectionId(Integer selectionId)

Parameters

Type	Name	Description
Integer	selectionId	Identifier for a selection.

Returns

Type	Description
Void

Examples

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

SetSourceInput(String)

Parameters specifying source and properties for template variable substitution.

Declaration

Void SetSourceInput(String 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

Examples

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