Class DocumentVariableCollection

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

Inheritance
System.Object
DocumentVariableCollection
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Flow.Model.Collections
Assembly: Telerik.Windows.Documents.Flow.dll

Syntax

public class DocumentVariableCollection : IEnumerable<KeyValuePair<string, string>>, IEnumerable

Properties

Count

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

Declaration
public int Count { get; }
Property Value
System.Int32

The count.

Item[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
public string this[string name] { get; set; }
Parameters
System.String name

Property Value
System.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
public void Add(string name, string value)
Parameters
System.String name

The name.
System.String value

The value.

Contains(String)

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

Declaration
public bool Contains(string name)
Parameters
System.String name

The name.
Returns
System.Boolean

GetEnumerator()

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

Declaration
public IEnumerator<KeyValuePair<string, string>> GetEnumerator()
Returns
System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<System.String, System.String>>

A System.Collections.Generic.IEnumerator<T> that can be used to iterate through the collection.
Implements
System.Collections.Generic.IEnumerable<T>.GetEnumerator()

Remove(String)

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

Declaration
public bool Remove(string name)
Parameters
System.String name

The name.
Returns
System.Boolean

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns a non-generic enumerator that iterates through the collection.

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
System.Collections.IEnumerator

An System.Collections.IEnumerator object that can be used to iterate through the collection.
Implements
System.Collections.IEnumerable.GetEnumerator()