Class
DocumentVariableCollection

Stores document variables as case-insensitive name-value pairs for use with merge fields and custom document metadata.

Definition

Namespace:Telerik.Windows.Documents.Flow.Model.Collections

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition

public class DocumentVariableCollection : IEnumerable

Inheritance: objectDocumentVariableCollection

Implements: IEnumerable

Properties

Count

Gets the number of document variables currently stored in the collection.

Declaration

cs-api-definition

public int Count { get; }

Property Value

int

The count.

this[string]

Gets or sets the value of the document variable with the specified name using case-insensitive matching, throwing if the name does not exist on get.

Declaration

cs-api-definition

public string this[string name] { get; set; }

Parameters

name

string

Property Value

string

The document variable name

Methods

Add(string, string)

Adds a new document variable or updates the existing variable's value if the name already exists.

Declaration

cs-api-definition

public void Add(string name, string value)

Parameters

name

string

The name.

value

string

The value.

Contains(string)

Determines whether the collection contains a document variable with the specified name using case-insensitive comparison.

Declaration

cs-api-definition

public bool Contains(string name)

Parameters

name

string

The name.

Returns

bool

GetEnumerator()

Returns an enumerator that iterates through all document variable name-value pairs in the collection.

Declaration

cs-api-definition

public IEnumerator<KeyValuePair<string, string>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<string, string>>

A IEnumerator<T> that can be used to iterate through the collection.

Remove(string)

Removes the document variable with the specified name and returns whether the removal was successful.

Declaration

cs-api-definition

public bool Remove(string name)

Parameters

name

string

The name.

Returns

bool

ClassDocumentVariableCollection

Class
DocumentVariableCollection