com.aspose.words

Class VariableCollection

java.lang.Object

com.aspose.words.VariableCollection

All Implemented Interfaces:

java.lang.Iterable

public class VariableCollection
extends java.lang.Object
implements java.lang.Iterable

A collection of document variables.

To learn more, visit the Work with Document Properties documentation article.

Variable names and values are strings.

Variable names are case-insensitive.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String name, java.lang.String value) Adds a document variable to the collection.
void	clear() Removes all elements from the collection.
boolean	contains(java.lang.String name) Determines whether the collection contains a document variable with the given name.
java.lang.String	get(int index) Gets a document variable at the specified index.
java.lang.String	get(java.lang.String name) Provides access to the collection items.
int	getCount() Gets the number of elements contained in the collection.
int	indexOfKey(java.lang.String name) Returns the zero-based index of the specified document variable in the collection.
java.util.Iterator	iterator() Returns an enumerator object that can be used to iterate over all variable in the collection.
void	remove(java.lang.String name) Removes a document variable with the specified name from the collection.
void	removeAt(int index) Removes a document variable at the specified index.
void	set(int index, java.lang.String value) Sets a document variable at the specified index.
void	set(java.lang.String name, java.lang.String value) Provides access to the collection items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getCount

public int getCount()

Gets the number of elements contained in the collection.

Returns:

The number of elements contained in the collection.

get

public java.lang.String get(java.lang.String name)

Provides access to the collection items. 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.

Returns:

The corresponding String value.

set

public void set(java.lang.String name,
                java.lang.String value)

Provides access to the collection items. 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.

Parameters:

value - The corresponding String value.

get

public java.lang.String get(int index)

Gets 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.

Returns:

A document variable at the specified index.

set

public void set(int index,
                java.lang.String value)

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.

value - A document variable at the specified index.

iterator

public java.util.Iterator iterator()

Returns an enumerator object that can be used to iterate over all variable in the collection.

Specified by:

iterator in interface java.lang.Iterable

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.

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.

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.

clear

public void clear()

Removes all elements from the collection.