CharacterStyleGroup
A character style group.
Go to Property Listing | Method Listing
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 |
|---|---|---|---|
|
readonly |
Lists all character styles (regardless of their group). |
||
|
readonly |
A collection of character style groups. |
||
|
readonly |
A collection of character styles. |
||
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
The unique ID of the CharacterStyleGroup. |
||
|
readonly |
The index of the CharacterStyleGroup within its containing object. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
The name of the CharacterStyleGroup. |
||
|
readonly |
The parent of the CharacterStyleGroup (a Document, Application or CharacterStyleGroup). |
||
|
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 |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
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 |
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.
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 |
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) |
undefined remove (replacingWith:Varies ParagraphStyle CharacterStyle)
Deletes the style.
|
Parameter |
Type |
Description |
|---|---|---|
|
replacingWith |
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 |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
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
CharacterStyleGroup.duplicate()
CharacterStyleGroup.getElements()
CharacterStyleGroups.anyItem()
CharacterStyleGroups.everyItem()
CharacterStyleGroups.nextItem()
CharacterStyleGroups.previousItem()
CharacterStyleGroups.itemByID()
CharacterStyleGroups.itemByName()
CharacterStyleGroups.itemByRange()
CharacterStyleGroups.firstItem()