DocumentPropertyCollection

DocumentPropertyCollection class

Base class for BuiltInDocumentPropertyCollection and CustomDocumentPropertyCollection collections.

Methods

NameDescription
add()Reserved for internal use.
clear()
contains(name)Returns true if a property with the specified name exists in the collection.
contains()Reserved for internal use.
get(name)Returns a DocumentProperty object by the name of the property. Returns null if a property with the specified name is not
get(index)Returns a DocumentProperty object by index.
get()Reserved for internal use.
getCount()
indexOf(name)Gets the index of a property by name.
indexOf()Reserved for internal use.
iterator()
remove(name)Removes a property with the specified name from the collection.
removeAt(index)Removes a property at the specified index.

add()

Reserved for internal use.

clear()

contains(name)

Returns true if a property with the specified name exists in the collection.

ParameterTypeDescription
nameStringThe case-insensitive name of the property.

Returns: boolean — boolean True if the property exists in the collection; false otherwise.

contains()

Reserved for internal use.

get(name)

Returns a DocumentProperty object by the name of the property. Returns null if a property with the specified name is not found.

ParameterTypeDescription
nameStringThe case-insensitive name of the property to retrieve.

get(index)

Returns a DocumentProperty object by index.

ParameterTypeDescription
indexNumberZero-based index of the

get()

Reserved for internal use.

getCount()

indexOf(name)

Gets the index of a property by name.

ParameterTypeDescription
nameStringThe case-insensitive name of the property.

Returns: Number — Number The zero based index. Negative value if not found.

indexOf()

Reserved for internal use.

iterator()

remove(name)

Removes a property with the specified name from the collection.

ParameterTypeDescription
nameStringThe case-insensitive name of the property.

removeAt(index)

Removes a property at the specified index.

ParameterTypeDescription
indexNumberThe zero based index.