Class CustomProperties

Class Summary
Constructor Attributes	Constructor Name and Description
	CustomProperties() A singleton object that provides an easy short-cut for accessing the Custom Properties in the Composition without having to traverse the object model.

Method Summary
Method Attributes	Method Name and Description
	set(pathType, propertyPath, newValue) Sets a new value into the specified Custom Property.
	value(pathType, propertyPath) Returns the value of the specified Custom Property.

Class Detail

CustomProperties()

A singleton object that provides an easy short-cut for accessing the Custom Properties in the Composition without having to traverse the object model.

Accessible through the $prop constant.

Method Detail

set(pathType, propertyPath, newValue)

Sets a new value into the specified Custom Property.

Parameters:

{String} pathType

Specifies the "starting point" of the path, relative to the current context in which the current Script is running. It can be any of the following values (case is not significant):

"Composition"
The path is relative to the Composition as a whole. (Therefore, the path must start with the name of a Band.)
"Band"
The path is relative to the current Band in which the Script is executing.
"Track"
The path is relative to the current Track in which the Script is executing.
"MessageClip" or "Clip" (either one is accepted)
The path is relative to the current Clip in which the Script is executing. If the Script is nested within multiple Clips, the path is relative to the lowest-level containing Clip (the Clip "nearest to" the Script in terms of the parentage hierarchy).
"Chain"
The path is relative to the current Chain in which the Script is executing. If the Script is nested within multiple Chains, the path is relative to the lowest-level containing Chain (the Chain "nearest to" the Script in terms of the parentage hierarchy).
"Group"
The path is relative to the current Group in which the Script is executing. If the Script is nested within multiple Groups, the path is relative to the lowest-level containing Group (the Group "nearest to" the Script in terms of the parentage hierarchy).
"Transaction"
The path is relative to the current Transaction in which the Script is executing. If the Script is nested within multiple Transactions, the path is relative to the lowest-level containing Transaction (the Transaction "nearest to" the Script in terms of the parentage hierarchy).
"If"
The path is relative to the current If in which the Script is executing. If the Script is nested within multiple Ifs, the path is relative to the lowest-level containing If (the If "nearest to" the Script in terms of the parentage hierarchy).
"Switch"
The path is relative to the current Switch in which the Script is executing. If the Script is nested within multiple Switch, the path is relative to the lowest-level containing Switch (the Switch "nearest to" the Script in terms of the parentage hierarchy).
"Page"
The path is relative to the current Page in which the Script is executing.
"Message"
The path is relative to the current Message in which the Script is executing.
"Browser Action"
The path is relative to the current Browser Action in which the Script is executing.
"Destination"
The path is relative to the current Message or Browser Action in which the Script is executing. Once the item is found, the result is to be the item's Target.

{String} propertyPath

Contains a property path as specified for "In Situ Substitution Specifications" (see the separate documentation on ISSEs).

{anything} newValue

The new value for the property. It can be null. (The "undefined" value is treated as null.)

value(pathType, propertyPath)

Returns the value of the specified Custom Property.