New to Telerik Document Processing? Start a free 30-day trial

DocumentVariableCollection

Class

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

Definition

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

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

Inheritance: objectDocumentVariableCollection

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

public void Add(string name, string value)

Parameters:namestring

The name.

The value.

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

public bool Contains(string name)

Parameters:namestring

The name.

Returns:

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

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

Returns:

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

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

public bool Remove(string name)

Parameters:namestring

The name.

Returns:

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

public int Count { get; }

Property Value:

The count.

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.

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

Parameters:namestringProperty Value:

The document variable name