Class TemplateVariablesParameters
Parameters specifying source and properties for template variable substitution.
Carrier object for TemplateVariablesParameters. Services for the TemplateVariablesParameters Carrier is available from the IDocumentAgent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class TemplateVariablesParameters : CarrierConstructors
TemplateVariablesParameters()
Default constructor
Declaration
public TemplateVariablesParameters()See Also
Properties
AppointmentId
Identifier for an appointment
Declaration
public virtual int AppointmentId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
ContactId
Identifier for a contact
Declaration
public virtual int ContactId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
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
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
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
public virtual DocumentEntity DocumentEntity { get; set; }Property Value
| Type | Description |
|---|---|
| DocumentEntity |
See Also
DocumentId
Identifier for a document
Declaration
public virtual int DocumentId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
Encoding
Encoding of source string. Non-text formats such as MsWord or Excel should be Base64 encoded in the source string.
Declaration
public virtual GeneratorEncoding Encoding { get; set; }Property Value
| Type | Description |
|---|---|
| GeneratorEncoding |
See Also
PersonId
Identifier for a person
Declaration
public virtual int PersonId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
ProductKey
Product key
Declaration
public virtual string ProductKey { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
ProjectId
Identifier for a project
Declaration
public virtual int ProjectId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
QuoteAlternativeId
Quote alternative id
Declaration
public virtual int QuoteAlternativeId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
QuoteLineId
Quote line id
Declaration
public virtual int QuoteLineId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
SaleId
Identifier for a sale
Declaration
public virtual int SaleId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
See Also
SelectionId
Identifier for a selection
Declaration
public virtual int SelectionId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
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
public virtual string SourceInput { get; set; }Property Value
| Type | Description |
|---|---|
| String |
See Also
TicketId
Identifier for ticket
Declaration
public virtual int TicketId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
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. |