com.aspose.words
Class VariableCollection

java.lang.Object
    extended by com.aspose.words.VariableCollection
All Implemented Interfaces:
java.lang.Iterable

public class VariableCollection 
extends java.lang.Object

A collection of document variables.

Variable names and values are strings.

Variable names are case-insensitive.

Example:

Shows how to enumerate over document variables.
Document doc = new Document(getMyDir() + "Document.doc");

for (java.util.Map.Entry entry : doc.getVariables())
{
    String name = entry.getKey().toString();
    String value = entry.getValue().toString();

    // Do something useful.
    System.out.println(MessageFormat.format("Name: {0}, Value: {1}", name, value));
}

Property Getters/Setters Summary
intgetCount()
           Gets the number of elements contained in the collection.
java.lang.Stringget(int index)
voidset(int index, java.lang.String value)
           Gets or sets a document variable at the specified index. null values are not allowed as a right hand side of the assignment and will be replaced by empty string.
java.lang.Stringget(java.lang.String name)
voidset(java.lang.String name, java.lang.String value)
           Gets or a sets a document variable by the case-insensitive name. null values are not allowed as a right hand side of the assignment and will be replaced by empty string.
 
Method Summary
voidadd(java.lang.String name, java.lang.String value)
           Adds a document variable to the collection.
voidclear()
           Removes all elements from the collection.
booleancontains(java.lang.String name)
           Determines whether the collection contains a document variable with the given name.
intindexOfKey(java.lang.String name)
           Returns the zero-based index of the specified document variable in the collection.
java.util.Iteratoriterator()
           Returns a dictionary iterator object that can be used to iterate over all items in the collection.
voidremove(java.lang.String name)
           Removes a document variable with the specified name from the collection.
voidremoveAt(int index)
           Removes a document variable at the specified index.
 

Property Getters/Setters Detail

getCount

public int getCount()
Gets the number of elements contained in the collection.

get/set

public java.lang.String get(int index) / public void set(int index, java.lang.String value)
Gets or sets a document variable at the specified index. null values are not allowed as a right hand side of the assignment and will be replaced by empty string.
Parameters:
index - Zero-based index of the document variable.

get/set

public java.lang.String get(java.lang.String name) / public void set(java.lang.String name, java.lang.String value)
Gets or a sets a document variable by the case-insensitive name. null values are not allowed as a right hand side of the assignment and will be replaced by empty string.

Method Detail

add

public void add(java.lang.String name, java.lang.String value)
Adds a document variable to the collection.
Parameters:
name - The case-insensitive name of the variable to add.
value - The value of the variable. The value cannot be null, if value is null empty string will be used instead.

clear

public void clear()
Removes all elements from the collection.

contains

public boolean contains(java.lang.String name)
Determines whether the collection contains a document variable with the given name.
Parameters:
name - Case-insensitive name of the document variable to locate.
Returns:
True if item is found in the collection; otherwise, false.

indexOfKey

public int indexOfKey(java.lang.String name)
Returns the zero-based index of the specified document variable in the collection.
Parameters:
name - The case-insensitive name of the variable.
Returns:
The zero based index. Negative value if not found.

iterator

public java.util.Iterator iterator()
Returns a dictionary iterator object that can be used to iterate over all items in the collection.

remove

public void remove(java.lang.String name)
Removes a document variable with the specified name from the collection.
Parameters:
name - The case-insensitive name of the variable.

removeAt

public void removeAt(int index)
Removes a document variable at the specified index.
Parameters:
index - The zero based index.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.