CharacterStyleGroup
QuickLinks
Hierarchy
Properties
| 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 | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the CharacterStyleGroup. |
| parent | ApplicationCharacterStyleGroup Document |
readonly | The parent of the CharacterStyleGroup (a Document, Application or CharacterStyleGroup). |
| properties | Object | r/w | A 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | 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. |
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.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
CharacterStyleGroup move (to:
LocationOptions[, reference:
varies])
Moves the style to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The location relative to the reference object or within the containing object. |
| reference | Application 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.
| Parameter | Type | Description |
|---|---|---|
| replacingWith | CharacterStyle 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the CharacterStyleGroup.
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, 29-Apr-2012 v3.0.3i | Contents :: Index |