K4 InDesign Javascript API Documentation

TextCharacterStyleGroup

A character style group.

Instance Properties

Name Description Access
allCharacterStyles CharacterStyle Lists all character styles (regardless of their group). read-only
characterStyleGroups CharacterStyleGroups A collection of character style groups. read-only
characterStyles CharacterStyles A collection of character styles. 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 CharacterStyleGroup. read-only
index number The index of the CharacterStyleGroup 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 CharacterStyleGroup. read-write
parent The parent of the CharacterStyleGroup (a Document, Application or CharacterStyleGroup). 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(
)
  → CharacterStyleGroup
extractLabel(
key)
  → string
getElements(
)
  → CharacterStyleGroup
insertLabel(
key, value)
move(
to, reference)
  → CharacterStyleGroup
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(
)
  → CharacterStyleGroup
Duplicates the CharacterStyleGroup.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → CharacterStyleGroup
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)
  → CharacterStyleGroup
Moves the style to the specified location.
to LocationOptions The location relative to the reference object or within the containing object.
reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional)
remove(
replacingWith)
Deletes the style.
replacingWith The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle. (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 CharacterStyleGroup.
toSpecifier(
)
  → string
Retrieves the object specifier.