Class PropertyList

Class Summary
Constructor Attributes	Constructor Name and Description
	PropertyList() An object that provides access to all of the Custom Properties contained within an item in the Composition.

Field Summary
Field Attributes	Field Name and Description
{String}	name The name of the object whose properties are being accessed.
{String[]}	propertyNames An array of all of the Custom Property names in the item.
{String}	type Always has the value "PropertyList".

Method Summary
Method Attributes	Method Name and Description
	createProperty(newPropertyName, sendToAnalytics) Creates a new Custom Property within the item that this list is for.
{various}	getPropertyValue(propertyName) Returns the current value of the specified Custom Property.
	setPropertyValue(propertyName, propertyValue) Sets the value of the specified Custom Property.

Class Detail

PropertyList()

An object that provides access to all of the Custom Properties contained within an item in the Composition.

Contained in the "propertyList" property of objects that represent items in the Composition.

Field Detail

{String} name

The name of the object whose properties are being accessed.

{String[]} propertyNames

An array of all of the Custom Property names in the item. Can be null if the item has no Custom Properties.

{String} type

Always has the value "PropertyList".

Method Detail

createProperty(newPropertyName, sendToAnalytics)

Creates a new Custom Property within the item that this list is for. The initial value of the property is null.

Parameters:
{String} newPropertyName: The name for the new property.
{boolean} sendToAnalytics Optional, Default: false: Optional. True if the new property's value should be sent to the Result Analytics. If this parameter is omitted or null, false is assumed.

{various} getPropertyValue(propertyName)

Returns the current value of the specified Custom Property.

Returns:: {various} The current value of the specified Custom Property. Can be null.

setPropertyValue(propertyName, propertyValue)

Sets the value of the specified Custom Property.

Classes