VariableCollection class

VariableCollection class

A collection of document variables. To learn more, visit the Work with Document Properties documentation article.

Remarks

Variable names and values are strings.

Variable names are case-insensitive.

Indexers

NameDescription
__getitem__(index)Gets or sets a document variable at the specified index. None values are not allowed as a right hand side of the assignment and will be replaced by empty string.

Properties

NameDescription
countGets the number of elements contained in the collection.

Methods

NameDescription
add(name, value)Adds a document variable to the collection.
clear()Removes all elements from the collection.
contains(name)Determines whether the collection contains a document variable with the given name.
get_by_name(name)Gets or a sets a document variable by the case-insensitive name. None values are not allowed as a right hand side of the assignment and will be replaced by empty string.
index_of_key(name)Returns the zero-based index of the specified document variable in the collection.
remove(name)Removes a document variable with the specified name from the collection.
remove_at(index)Removes a document variable at the specified index.

See Also