Adobe InDesign CS5 (7.0) Object Model JS: ObjectStyleGroup

InDesign CS5

Class

ObjectStyleGroup

 An object style group.

QuickLinks

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

Hierarchy

Application | Document | ObjectStyleGroup
ObjectStyleGroup
Event | EventListener | MutationEvent | ObjectStyle | ObjectStyleGroup

Properties

PropertyTypeAccessDescription
allObjectStylesArray of ObjectStyle readonlyAll object styles contained by the ObjectStyleGroup.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the ObjectStyleGroup.
indexnumber readonlyThe index of the ObjectStyleGroup within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the ObjectStyleGroup.
objectStyleGroupsObjectStyleGroups readonlyA collection of object style groups.
objectStylesObjectStyles readonlyA collection of object styles.
parentApplicationDocument
ObjectStyleGroup
readonlyThe parent of the ObjectStyleGroup (a Document, Application or ObjectStyleGroup).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

ObjectStyleGroup duplicate ()
Duplicates the ObjectStyleGroup.

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

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

ParameterTypeDescription
toLocationOptions:
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.
referenceApplication
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.

ParameterTypeDescription
replacingWithObjectStyleThe ObjectStyleGroup to apply in place of the deleted ObjectStyleGroup. (Optional)

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

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

ObjectStyle.parent

ObjectStyleGroup.parent

Used in:

ObjectStyleGroup ObjectStyleGroups.nextItem (obj: ObjectStyleGroup)

ObjectStyleGroup ObjectStyleGroups.previousItem (obj: ObjectStyleGroup)

Return

ObjectStyleGroup ObjectStyleGroup.duplicate ()

Array of ObjectStyleGroup ObjectStyleGroup.getElements ()

ObjectStyleGroup ObjectStyleGroup.move (to: LocationOptions[, reference: varies])

ObjectStyleGroup ObjectStyleGroups.[] (index: number)

ObjectStyleGroup ObjectStyleGroups.add ([withProperties: Object])

ObjectStyleGroup ObjectStyleGroups.anyItem ()

Array of ObjectStyleGroup ObjectStyleGroups.everyItem ()

ObjectStyleGroup ObjectStyleGroups.firstItem ()

ObjectStyleGroup ObjectStyleGroups.item (index: varies)

ObjectStyleGroup ObjectStyleGroups.itemByID (id: number)

ObjectStyleGroup ObjectStyleGroups.itemByName (name: string)

Array of ObjectStyleGroup ObjectStyleGroups.itemByRange (from: varies, to: varies)

ObjectStyleGroup ObjectStyleGroups.lastItem ()

ObjectStyleGroup ObjectStyleGroups.middleItem ()

ObjectStyleGroup ObjectStyleGroups.nextItem (obj: ObjectStyleGroup)

ObjectStyleGroup ObjectStyleGroups.previousItem (obj: ObjectStyleGroup)

Jongware, 20-Jun-2010 v3.0.3dContents :: Index