Class TemplateVariablesParameters

Parameters specifying source and properties for template variable substitution.

Carrier object for TemplateVariablesParameters. Services for the TemplateVariablesParameters Carrier is available from the Document Agent.
Inheritance
object
TemplateVariablesParameters
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class TemplateVariablesParameters : Carrier

Constructors

TemplateVariablesParameters()

Default constructor

Declaration
public TemplateVariablesParameters()
See Also

Properties

AppointmentId

Identifier for an appointment

Declaration
[DataMember]
public virtual int AppointmentId { get; set; }
Property Value
Type Description
int
See Also

ContactId

Identifier for a contact

Declaration
[DataMember]
public virtual int ContactId { get; set; }
Property Value
Type Description
int
See Also

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.

Declaration
[DataMember]
public virtual string CultureName { get; set; }
Property Value
Type Description
string
See Also

CustomTags

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

Declaration
[DataMember]
public virtual string[][] CustomTags { get; set; }
Property Value
Type Description
string[][]
See Also

DocumentEntity

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

Declaration
[DataMember]
public virtual DocumentEntity DocumentEntity { get; set; }
Property Value
Type Description
DocumentEntity
See Also

DocumentId

Identifier for a document

Declaration
[DataMember]
public virtual int DocumentId { get; set; }
Property Value
Type Description
int
See Also

Encoding

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

Declaration
[DataMember]
public virtual GeneratorEncoding Encoding { get; set; }
Property Value
Type Description
GeneratorEncoding
See Also

PersonId

Identifier for a person

Declaration
[DataMember]
public virtual int PersonId { get; set; }
Property Value
Type Description
int
See Also

ProductKey

Product key

Declaration
[DataMember]
public virtual string ProductKey { get; set; }
Property Value
Type Description
string
See Also

ProjectId

Identifier for a project

Declaration
[DataMember]
public virtual int ProjectId { get; set; }
Property Value
Type Description
int
See Also

QuoteAlternativeId

Quote alternative id

Declaration
[DataMember]
public virtual int QuoteAlternativeId { get; set; }
Property Value
Type Description
int
See Also

QuoteLineId

Quote line id

Declaration
[DataMember]
public virtual int QuoteLineId { get; set; }
Property Value
Type Description
int
See Also

SaleId

Identifier for a sale

Declaration
[DataMember]
public virtual int SaleId { get; set; }
Property Value
Type Description
int
See Also

SelectionId

Identifier for a selection

Declaration
[DataMember]
public virtual int SelectionId { get; set; }
Property Value
Type Description
int
See Also

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.

Declaration
[DataMember]
public virtual string SourceInput { get; set; }
Property Value
Type Description
string
See Also

TicketId

Identifier for ticket

Declaration
[DataMember]
public virtual int TicketId { get; set; }
Property Value
Type Description
int
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also