CustomDocumentPropertyCollection

CustomDocumentPropertyCollection class

A collection of custom document properties. Each DocumentProperty object represents a custom property of a container document.

Methods

Name	Description
add(name, value)	Creates a new custom document property of the PropertyType.String data type.
add(name, value)	Creates a new custom document property of the PropertyType.Number data type.
add(name, value)	Creates a new custom document property of the PropertyType.DateTime data type.
add(name, value)	Creates a new custom document property of the PropertyType.Boolean data type.
add(name, value)	Creates a new custom document property of the PropertyType.Float data type.
add()	Reserved for internal use.
addLinkToContent(name, source)	Creates a new custom document property which links to content.
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.
updateLinkedPropertyValue()	Update custom document property value which links to content.
updateLinkedRange()	Update custom document property value to linked range.

add(name, value)

Creates a new custom document property of the PropertyType.String data type.

Parameter	Type	Description
name	String	The name of the property.
value	String	The value of the property.

Returns: DocumentProperty — DocumentProperty The newly created property object.

add(name, value)

Creates a new custom document property of the PropertyType.Number data type.

Parameter	Type	Description
name	String	The name of the property.
value	Number	The value of the property.

Returns: DocumentProperty — DocumentProperty The newly created property object.

add(name, value)

Creates a new custom document property of the PropertyType.DateTime data type.

Parameter	Type	Description
name	String	The name of the property.
value	DateTime	The value of the property.

Returns: DocumentProperty — DocumentProperty The newly created property object.

add(name, value)

Creates a new custom document property of the PropertyType.Boolean data type.

Parameter	Type	Description
name	String	The name of the property.
value	boolean	The value of the property.

Returns: DocumentProperty — DocumentProperty The newly created property object.

add(name, value)

Creates a new custom document property of the PropertyType.Float data type.

Parameter	Type	Description
name	String	The name of the property.
value	Number	The value of the property.

Returns: DocumentProperty — DocumentProperty The newly created property object.

add()

Reserved for internal use.

addLinkToContent(name, source)

Creates a new custom document property which links to content.

Parameter	Type	Description
name	String	The name of the property.
source	String	The source of the property

Returns: DocumentProperty — DocumentProperty The newly created property object.

clear()

contains(name)

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

Parameter	Type	Description
name	String	The 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.

Parameter	Type	Description
name	String	The case-insensitive name of the property to retrieve.

get(index)

Returns a DocumentProperty object by index.

Parameter	Type	Description
index	Number	Zero-based index of the

get()

Reserved for internal use.

getCount()

indexOf(name)

Gets the index of a property by name.

Parameter	Type	Description
name	String	The 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.

Parameter	Type	Description
name	String	The case-insensitive name of the property.

removeAt(index)

Removes a property at the specified index.

Parameter	Type	Description
index	Number	The zero based index.

updateLinkedPropertyValue()

Update custom document property value which links to content.

updateLinkedRange()

Update custom document property value to linked range.