Methods

add(name, value) → DocumentProperty

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

Parameters

Name Type Optional Description

name

String

 

The name of the property.

value

String

 

The value of the property.

Returns

DocumentProperty The newly created property object.

add(name, value) → DocumentProperty

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

Parameters

Name Type Optional Description

name

String

 

The name of the property.

value

Number

 

The value of the property.

Returns

DocumentProperty The newly created property object.

add(name, value) → DocumentProperty

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

Parameters

Name Type Optional Description

name

String

 

The name of the property.

value

DateTime

 

The value of the property.

Returns

DocumentProperty The newly created property object.

add(name, value) → DocumentProperty

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

Parameters

Name Type Optional Description

name

String

 

The name of the property.

value

boolean

 

The value of the property.

Returns

DocumentProperty The newly created property object.

add(name, value) → DocumentProperty

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

Parameters

Name Type Optional Description

name

String

 

The name of the property.

value

Number

 

The value of the property.

Returns

DocumentProperty The newly created property object.

addLinkToContent(name, source) → DocumentProperty

Creates a new custom document property which links to content.

Parameters

Name Type Optional Description

name

String

 

The name of the property.

source

String

 

The source of the property

Returns

DocumentProperty The newly created property object.

clear()

Removes all properties from the collection.

contains(name) → boolean

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

Parameter

Name Type Optional Description

name

String

 

The case-insensitive name of the property.

Returns

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

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

Name Type Optional Description

name

String

 

The case-insensitive name of the property to retrieve.

get(index)

Returns a DocumentProperty object by index.

Parameter

Name Type Optional Description

index

Number

 

Zero-based index of the

getCount()

Gets number of items in the collection.

indexOf(name) → Number

Gets the index of a property by name.

Parameter

Name Type Optional Description

name

String

 

The case-insensitive name of the property.

Returns

Number The zero based index. Negative value if not found.

iterator() → Iterator

Returns

Iterator 

remove(name)

Removes a property with the specified name from the collection.

Parameter

Name Type Optional Description

name

String

 

The case-insensitive name of the property.

removeAt(index)

Removes a property at the specified index.

Parameter

Name Type Optional 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.