ObjectStyleGroup

An object style group.

Go to Property Listing | Method Listing

Methods:

addEventListener, duplicate, extractLabel, getElements, insertLabel, move, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, ObjectStyle, ObjectStyleGroups, ObjectStyles, String

Property Listing

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	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
name	String	read/write	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	read/write	A property that allows setting of several properties at the same time.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

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

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

ObjectStyleGroup getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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 Document ObjectStyle ObjectStyleGroup Application)

Moves the ObjectStyleGroup to the specified location.

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

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The new location relative to the reference object or within the container object.

reference

The reference object. Note: Required when the to parameter is before or after. Can accept: ObjectStyle, ObjectStyleGroup, Document or Application. (Optional)

undefined remove (replacingWith:ObjectStyle)

Deletes the ObjectStyleGroup.

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

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

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the ObjectStyleGroup.

String toSpecifier ()

Retrieves the object specifier.