ObjectStyleGroup

An object style group.

Application | Document | ObjectStyleGroup

ObjectStyleGroup

Property	Type	Access	Description
allObjectStyles	Array of ObjectStyle	readonly	All object styles contained by the ObjectStyleGroup.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	number	readonly	The unique ID of the ObjectStyleGroup.
index	number	readonly	The index of the ObjectStyleGroup 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 ObjectStyleGroup.
objectStyleGroups	ObjectStyleGroups ObjectStyleGroup	readonly	A collection of object style groups.
objectStyles	ObjectStyles ObjectStyle	readonly	A collection of object styles.
parent	Application Document ObjectStyleGroup	readonly	The parent of the ObjectStyleGroup (a Document, Application or ObjectStyleGroup).
properties	Object	r/w	A property that allows setting of several properties at the same time.

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

ObjectStyleGroup duplicate ()
Duplicates the ObjectStyleGroup.

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

Parameter	Type	Description
key	string	The key.

Array of ObjectStyleGroup 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.

ObjectStyleGroup move (to: LocationOptions[, reference: varies])
Moves the ObjectStyleGroup to the specified location.

Parameter	Type	Description
to	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN	The new location relative to the reference object or within the container object.
reference	Application Document ObjectStyle ObjectStyleGroup	The reference object. Note: Required when the to parameter is before or after. Can accept: ObjectStyle, ObjectStyleGroup, Document or Application. (Optional)

void remove ([replacingWith: ObjectStyle])
Deletes the ObjectStyleGroup.

Parameter	Type	Description
replacingWith	ObjectStyle	The ObjectStyleGroup to apply in place of the deleted ObjectStyleGroup. (Optional)

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)