Adobe InDesign CS4 (6.0) Object Model JS: ConditionSet

previous page next page

Class

ConditionSet

A condition set for conditional text.

ConditionSet

Property	Type	Access	Description
id	number	readonly	The unique ID of the ConditionSet.
index	number	readonly	The index of the ConditionSet within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the ConditionSet.
parent	Application Document	readonly	The parent of the ConditionSet (a Application or Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
setConditions	Array of Ordered array containing condition:Condition visibility:Boolean	r/w	List of conditions and visibilities in the set. Can return: Ordered array containing condition:Condition, visibility:Boolean.

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of ConditionSet getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void redefine ()
Redefine a condition set with the currently existing conditions and visibilities.

void remove ([replacingWith: any])
Delete a condition set for conditional text.

Parameter	Type	Description
replacingWith	ConditionSet String	The condition set to apply to the text in place of the deleted condition set. By default, no condition set is applied in place of the deleted condition set. Can accept: ConditionSet or String. (Optional)

string toSource ()
Generates a string which, if executed, will return the ConditionSet.

string toSpecifier ()
Retrieves the object specifier.