InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

CharacterStyleGroup

A character style group.

Hierarchy

Application | CharacterStyleGroup | Document

CharacterStyleGroup

CharacterStyle | CharacterStyleGroup

Properties

NameType AccessDescription
CharacterStyle[] readonly Lists all character styles (regardless of their group).
CharacterStyleGroups<CharacterStyleGroup> readonly A collection of character style groups.
CharacterStyles<CharacterStyle> readonly A collection of character styles.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the CharacterStyleGroup.
Number readonly The index of the CharacterStyleGroup within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the CharacterStyleGroup.
Application | CharacterStyleGroup | Document readonly The parent of the CharacterStyleGroup (a Document, Application or CharacterStyleGroup).
Object read/write A property that allows setting of several properties at the same time.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Gets the label value associated with the specified key.

key String The key.
→ CharacterStyleGroup[]

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

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ CharacterStyleGroup

Moves the style to the specified location.

to LocationOptions The location relative to the reference object or within the containing object.
reference? CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | Application 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.
→ void

Deletes the style.

replacingWith? ParagraphStyle | CharacterStyle The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle.
→ Boolean

Removes the event listener.

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.
→ String

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

→ String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a CharacterStyleGroup.

CharacterStyle.parentCharacterStyleGroup.parentEvent.parentEventListener.parentMutationEvent.parent

Parameter of 11

Method parameters that accept a CharacterStyleGroup.

CellStyle.move(reference)CellStyleGroup.move(reference)CharacterStyle.move(reference)CharacterStyleGroup.move(reference)CharacterStyleGroups.itemByRange(from)CharacterStyleGroups.nextItem(obj)CharacterStyleGroups.previousItem(obj)ParagraphStyle.move(reference)ParagraphStyleGroup.move(reference)TableStyle.move(reference)TableStyleGroup.move(reference)

Return 16

Methods that return a CharacterStyleGroup.

CharacterStyleGroup.duplicate()CharacterStyleGroup.getElements()CharacterStyleGroup.move()CharacterStyleGroups.[]()CharacterStyleGroups.add()CharacterStyleGroups.anyItem()CharacterStyleGroups.everyItem()CharacterStyleGroups.firstItem()CharacterStyleGroups.item()CharacterStyleGroups.itemByID()CharacterStyleGroups.itemByName()CharacterStyleGroups.itemByRange()CharacterStyleGroups.lastItem()CharacterStyleGroups.middleItem()CharacterStyleGroups.nextItem()CharacterStyleGroups.previousItem()