DS.Documents.Word Assembly

GrapeCity.Documents.Word.VariableCollection

VariableCollection Class

A collection of Variable objects that represent the variables added to a document or template. Document variables are used to preserve macro settings in between macro sessions.

Inheritance

object

VariableCollection

Implements

IReadOnlyList<Variable>

IReadOnlyCollection<Variable>

IEnumerable<Variable>

IEnumerable

Namespace: GrapeCity.Documents.Word

Assembly: DS.Documents.Word.dll

Syntax

public class VariableCollection : IReadOnlyList<Variable>, IReadOnlyCollection<Variable>, IEnumerable<Variable>, IEnumerable

Public Class VariableCollection
    Implements IReadOnlyList(Of Variable), IReadOnlyCollection(Of Variable), IEnumerable(Of Variable), IEnumerable

Properties

Name	Description
Count	Returns the number of variables in the document.
this[int]	Gets a document variable at the specified index.
this[string]	Gets a document variable by the case-insensitive name.

Methods

Name	Description
Add(string, string)	Adds a varibale into the document.
Clear()	Removes all elements from the collection.
Contains(string)	Gets whether a varibale with specified name exists in the document.
Remove(int)	Removes a document variable at the specified index.
Remove(string)	Removes a document variable with the specified name from the collection.
TryGetValue(string, out Variable)	Tries to get a variable by its name.