CharacterStyleGroup

A character style group.

Methods:

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

Objects:

Boolean, CharacterStyle, CharacterStyleGroups, CharacterStyles, EventListeners, Events, Number, Object, String

Property Listing

Property

Type

Access

Description

allCharacterStyles

Array of CharacterStyle

readonly

Lists all character styles (regardless of their group).

characterStyleGroups

CharacterStyleGroups CharacterStyleGroup

readonly

A collection of character style groups.

characterStyles

CharacterStyles CharacterStyle

readonly

A collection of character styles.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the CharacterStyleGroup.

index

Number

readonly

The index of the CharacterStyleGroup within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the CharacterStyleGroup.

parent

Application

CharacterStyleGroup

Document

readonly

The parent of the CharacterStyleGroup (a Document, Application or CharacterStyleGroup).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

CharacterStyleGroup duplicate ()

Duplicates the CharacterStyleGroup.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

CharacterStyleGroup getElements ()

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

undefined insertLabel (key:String, value:String)

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

Parameter

Type

Description

key

String

The key.

value

String

The value.

CharacterStyleGroup move (to:LocationOptions, reference:Varies CellStyle CellStyleGroup CharacterStyle CharacterStyleGroup Document ParagraphStyle ParagraphStyleGroup TableStyle TableStyleGroup Application)

Moves the style to the specified location.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

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. (Optional)

undefined remove (replacingWith:Varies ParagraphStyle CharacterStyle)

Deletes the style.

Parameter

Type

Description

replacingWith

ParagraphStyle

CharacterStyle

The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle. (Optional)

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

CharacterStyle.parent

CharacterStyleGroup.parent

Event.parent

EventListener.parent

MutationEvent.parent

Return

CharacterStyleGroups.add()

CharacterStyleGroup.duplicate()

CharacterStyleGroup.move()

CharacterStyleGroup.getElements()

CharacterStyleGroups.anyItem()

CharacterStyleGroups.everyItem()

CharacterStyleGroups.nextItem()

CharacterStyleGroups.previousItem()

CharacterStyleGroups.itemByID()

CharacterStyleGroups.item()

CharacterStyleGroups.[]()

CharacterStyleGroups.itemByName()

CharacterStyleGroups.itemByRange()

CharacterStyleGroups.firstItem()

CharacterStyleGroups.lastItem()

CharacterStyleGroups.middleItem()