Class DocumentVariableCollection

Represents a collection of all document variables in a RadDocument.

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.WinForms.Documents.Model
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public class DocumentVariableCollection : IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable

Constructors

DocumentVariableCollection(RadDocument)

Initializes a new instance of the DocumentVariableCollection class.

Declaration
public DocumentVariableCollection(RadDocument owner)
Parameters
RadDocument owner

The associated document.

DocumentVariableCollection(RadDocument, DocumentVariableCollection)

Initializes a new instance of the DocumentVariableCollection class.

Declaration
public DocumentVariableCollection(RadDocument owner, DocumentVariableCollection toCopyFrom)
Parameters
RadDocument owner

The associated document.
DocumentVariableCollection toCopyFrom

A collection of document variables which will be added to the associated document.

Properties

Count

Gets the number of elements contained in the System.Collections.Generic.ICollection<T>.

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

Implements
System.Collections.Generic.ICollection<T>.Count

IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection<T> is read-only.

Declaration
public bool IsReadOnly { get; }
Property Value
System.Boolean

Implements
System.Collections.Generic.ICollection<T>.IsReadOnly

Item[String]

Gets or sets the variable with the specified key.

Declaration
public object this[string key] { get; set; }
Parameters
System.String key

The key of the variable.
Property Value
System.Object

The document variable.
Implements
System.Collections.Generic.IDictionary<TKey, TValue>.Item[TKey]

Keys

Gets an System.Collections.Generic.ICollection<T> containing the keys of the System.Collections.Generic.IDictionary<TKey, TValue>.

Declaration
public ICollection<string> Keys { get; }
Property Value
System.Collections.Generic.ICollection<System.String>

Implements
System.Collections.Generic.IDictionary<TKey, TValue>.Keys

Values

Gets an System.Collections.Generic.ICollection<T> containing the values in the System.Collections.Generic.IDictionary<TKey, TValue>.

Declaration
public ICollection<object> Values { get; }
Property Value
System.Collections.Generic.ICollection<System.Object>

Implements
System.Collections.Generic.IDictionary<TKey, TValue>.Values

Methods

Add(String, Object)

Adds an element with the provided key and value to the System.Collections.Generic.IDictionary<TKey, TValue>.

Declaration
public void Add(string key, object value)
Parameters
System.String key

The object to use as the key of the element to add.
System.Object value

The object to use as the value of the element to add.
Implements
System.Collections.Generic.IDictionary<TKey, TValue>.Add(TKey, TValue)

Clear()

Removes all items from the System.Collections.Generic.ICollection<T>.

Declaration
public void Clear()
Implements
System.Collections.Generic.ICollection<T>.Clear()

ContainsKey(String)

Determines whether the System.Collections.Generic.IDictionary<TKey, TValue> contains an element with the specified key.

Declaration
public bool ContainsKey(string key)
Parameters
System.String key

The key to locate in the System.Collections.Generic.IDictionary<TKey, TValue>.
Returns
System.Boolean

true if the System.Collections.Generic.IDictionary<TKey, TValue> contains an element with the key; otherwise, false.
Implements
System.Collections.Generic.IDictionary<TKey, TValue>.ContainsKey(TKey)

EvaluateVariableValue(String)

Evaluates the variable value.

Declaration
public object EvaluateVariableValue(string variableName)
Parameters
System.String variableName

Name of the variable.
Returns
System.Object

The value of the variable.

GetEnumerator()

Returns an enumerator that iterates through the collection.

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

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

Remove(String)

Removes the element with the specified key from the System.Collections.Generic.IDictionary<TKey, TValue>.

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

The key of the element to remove.
Returns
System.Boolean

true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original System.Collections.Generic.IDictionary<TKey, TValue>.
Implements
System.Collections.Generic.IDictionary<TKey, TValue>.Remove(TKey)

TryGetValue(String, out Object)

Gets the value associated with the specified key.

Declaration
public bool TryGetValue(string key, out object value)
Parameters
System.String key

The key whose value to get.
System.Object value

When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.
Returns
System.Boolean

true if the object that implements System.Collections.Generic.IDictionary<TKey, TValue> contains an element with the specified key; otherwise, false.
Implements
System.Collections.Generic.IDictionary<TKey, TValue>.TryGetValue(TKey, TValue)

Explicit Interface Implementations

ICollection<KeyValuePair<String, Object>>.Add(KeyValuePair<String, Object>)

Declaration
void ICollection<KeyValuePair<string, object>>.Add(KeyValuePair<string, object> item)
Parameters
System.Collections.Generic.KeyValuePair<System.String, System.Object> item

Implements
System.Collections.Generic.ICollection<T>.Add(T)

ICollection<KeyValuePair<String, Object>>.Contains(KeyValuePair<String, Object>)

Declaration
bool ICollection<KeyValuePair<string, object>>.Contains(KeyValuePair<string, object> item)
Parameters
System.Collections.Generic.KeyValuePair<System.String, System.Object> item

Returns
System.Boolean

Implements
System.Collections.Generic.ICollection<T>.Contains(T)

ICollection<KeyValuePair<String, Object>>.CopyTo(KeyValuePair<String, Object>[], Int32)

Declaration
void ICollection<KeyValuePair<string, object>>.CopyTo(KeyValuePair<string, object>[] array, int arrayIndex)
Parameters
System.Collections.Generic.KeyValuePair<System.String, System.Object>[] array

System.Int32 arrayIndex

Implements
System.Collections.Generic.ICollection<T>.CopyTo(T[], System.Int32)

ICollection<KeyValuePair<String, Object>>.Remove(KeyValuePair<String, Object>)

Declaration
bool ICollection<KeyValuePair<string, object>>.Remove(KeyValuePair<string, object> item)
Parameters
System.Collections.Generic.KeyValuePair<System.String, System.Object> item

Returns
System.Boolean

Implements
System.Collections.Generic.ICollection<T>.Remove(T)

IEnumerable.GetEnumerator()

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

Implements
System.Collections.IEnumerable.GetEnumerator()

Extension Methods