K4 InDesign Javascript API Documentation

TextObjectStyleGroup

An object style group.

Instance Properties

Name Description Access
allObjectStyles ObjectStyle All object styles contained by the ObjectStyleGroup. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the ObjectStyleGroup. read-only
index number The index of the ObjectStyleGroup within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the ObjectStyleGroup. read-write
objectStyleGroups ObjectStyleGroups A collection of object style groups. read-only
objectStyles ObjectStyles A collection of object styles. read-only
parent The parent of the ObjectStyleGroup (a Document, Application or ObjectStyleGroup). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → ObjectStyleGroup
extractLabel(
key)
  → string
getElements(
)
  → ObjectStyleGroup
insertLabel(
key, value)
move(
to, reference)
  → ObjectStyleGroup
remove(
[replacingWith])
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
duplicate(
)
  → ObjectStyleGroup
Duplicates the ObjectStyleGroup.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → ObjectStyleGroup
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
move(
to, reference)
  → ObjectStyleGroup
Moves the ObjectStyleGroup to the specified location.
to LocationOptions 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)
remove(
[replacingWith])
Deletes the ObjectStyleGroup.
replacingWith ObjectStyle The ObjectStyleGroup to apply in place of the deleted ObjectStyleGroup. (Optional)
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the ObjectStyleGroup.
toSpecifier(
)
  → string
Retrieves the object specifier.