Skip to main content

Class TemplateVariablesParameters

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for TemplateVariablesParameters. Parameters specifying source and properties for template variable substitution.

Inheritance

objectCarrierTemplateVariablesParameters

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

TemplateVariablesParameters()

Default constructor - defaults any enum props to 0.

Properties

AppointmentId

Identifier for an appointment

Property Value

int

ContactId

Identifier for a contact

Property Value

int

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.

Property Value

string

CustomTags

Array with custom tags and values. Array may be of unlimited height, but need to be exactly 2 in width.

Property Value

string[][]

DocumentEntity

Custom document entity to use for data retrieval. Useful for unsaved data. DocumentEntity.DocumentId need to match the DocumentId specified in separate property.

Property Value

DocumentEntity

DocumentId

Identifier for a document

Property Value

int

Encoding

Encoding of source string. Non-text formats such as MsWord or Excel should be Base64 encoded in the source string. NULL if unknown enum value.

Property Value

GeneratorEncoding?

See Also

TemplateVariablesParameters.Encoding_String

Encoding_String

Encoding of source string. Non-text formats such as MsWord or Excel should be Base64 encoded in the source string. Raw string enum value.

Property Value

string

See Also

TemplateVariablesParameters.Encoding

PersonId

Identifier for a person

Property Value

int

ProductKey

Product key

Property Value

string

ProjectId

Identifier for a project

Property Value

int

QuoteAlternativeId

Quote alternative id

Property Value

int

QuoteLineId

Quote line id

Property Value

int

SaleId

Identifier for a sale

Property Value

int

SelectionId

Identifier for a selection

Property Value

int

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.

Property Value

string

TicketId

Identifier for ticket

Property Value

int

See Also

DocumentAgent