Attributes

An Attribute is a read-only, system-defined element: a name/value pair, where the name is case-insensitive. It holds certain information about a certain Node in the Metadata structure. This information can be static (e.g. the size of a physical page) or evaluated on-the-fly (e.g. the number of documents in a group).
Attributes are non-repetitive (i.e. name is unique) and do not persist through Metadata recreation.

For an overview of Attributes and the Node types in which they are available, see the Metadata Attributes reference.

Attributes are stored in a collection container object, just like the Node's Fields. As is the case with the different types of Nodes, both collections share a number of methods and properties. The Fields collection however has additional methods to support multiple entries with the same name, which is forbidden with attributes.

Caution: Attributes are intended for system-defined data. Please restrict user-defined data to Fields, and do not modify the Attributes.

Properties

Name Type Description

Count

Integer

Returns the number of elements in the collection.

Methods

Name Return type Description

Add(const String Name, const String Value)

 

Adds a new element to the collection or overwrites its value.

Clear()

 

Clears all elements from the collection.

CountByName(const String Name)

Integer

Returns the number of elements with the specified name.

Delete(Integer Index)

 

Deletes the element at the specified index.

Item(Integer Index)

String

Returns the value of the element stored at the specified index.

ItemByName(const String Name)

String

Returns the value of the element of the specified name.

Name(Integer Index)

String

Returns the name of the element stored at the specified index.