Adobe InDesign CS5 Server (7.0) Object Model JS: CharacterStyleGroup

InDesign Server CS5

Class

CharacterStyleGroup

 A character style group.

QuickLinks

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

Hierarchy

Application | CharacterStyleGroup | Document
CharacterStyleGroup
CharacterStyle | CharacterStyleGroup | Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
allCharacterStyles Array of CharacterStyle readonlyLists all character styles (regardless of their group).
characterStyleGroupsCharacterStyleGroups readonlyA collection of character style groups.
characterStylesCharacterStyles readonlyA collection of character styles.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the CharacterStyleGroup.
indexnumber readonlyThe index of the CharacterStyleGroup 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 CharacterStyleGroup.
parentApplicationCharacterStyleGroup
Document
readonlyThe parent of the CharacterStyleGroup (a Document, Application or CharacterStyleGroup).
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)

CharacterStyleGroup duplicate ()
Duplicates the CharacterStyleGroup.

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

ParameterTypeDescription
keystringThe key.

Array of CharacterStyleGroup 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.

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

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceApplication
CellStyle
CellStyleGroup
CharacterStyle
CharacterStyleGroup
Document
ParagraphStyle
ParagraphStyleGroup
TableStyle
TableStyleGroup
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)

void remove ([replacingWith: varies])
Deletes the style.

ParameterTypeDescription
replacingWithCharacterStyle
ParagraphStyle
The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle. (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 CharacterStyleGroup.

string toSpecifier ()
Retrieves the object specifier.

Element of

CharacterStyle.parent

CharacterStyleGroup.parent

Used in:

CharacterStyleGroup CharacterStyleGroups.nextItem (obj: CharacterStyleGroup)

CharacterStyleGroup CharacterStyleGroups.previousItem (obj: CharacterStyleGroup)

Return

CharacterStyleGroup CharacterStyleGroup.duplicate ()

Array of CharacterStyleGroup CharacterStyleGroup.getElements ()

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

CharacterStyleGroup CharacterStyleGroups.[] (index: number)

CharacterStyleGroup CharacterStyleGroups.add ([withProperties: Object])

CharacterStyleGroup CharacterStyleGroups.anyItem ()

Array of CharacterStyleGroup CharacterStyleGroups.everyItem ()

CharacterStyleGroup CharacterStyleGroups.firstItem ()

CharacterStyleGroup CharacterStyleGroups.item (index: varies)

CharacterStyleGroup CharacterStyleGroups.itemByID (id: number)

CharacterStyleGroup CharacterStyleGroups.itemByName (name: string)

Array of CharacterStyleGroup CharacterStyleGroups.itemByRange (from: varies, to: varies)

CharacterStyleGroup CharacterStyleGroups.lastItem ()

CharacterStyleGroup CharacterStyleGroups.middleItem ()

CharacterStyleGroup CharacterStyleGroups.nextItem (obj: CharacterStyleGroup)

CharacterStyleGroup CharacterStyleGroups.previousItem (obj: CharacterStyleGroup)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index