CharacterStyleGroup

A character style group.

Properties

Property	Type	Access	Description
allCharacterStyles	Array of CharacterStyle	readonly	Lists all character styles (regardless of their group).
characterStyleGroups	CharacterStyleGroups	readonly	A collection of character style groups.
characterStyles	CharacterStyles	readonly	A collection of character styles.
id	number	readonly	The unique ID of the CharacterStyleGroup.
index	number	readonly	The index of the CharacterStyleGroup within its containing object.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the CharacterStyleGroup.
parent	any	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

CharacterStyleGroupduplicate ()
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 CharacterStyleGroupgetElements ()
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.

CharacterStyleGroupmove (to:
LocationOptions[, reference:
any])
Moves the CharacterStyleGroup to the specified location.

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

void remove ([replacingWith:
any])
Deletes the CharacterStyleGroup.

Parameter	Type	Description
replacingWith	ParagraphStyle CharacterStyle	The CharacterStyleGroup to apply in place of the deleted CharacterStyleGroup. Can accept: ParagraphStyle or CharacterStyle. (Optional)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

CharacterStyleGroups.previousItem (

obj:
CharacterStyleGroup )

CharacterStyleGroups.nextItem (

obj:
CharacterStyleGroup )

Returned by:

CharacterStyleGroup CharacterStyleGroup .duplicate (

)

Array of CharacterStyleGroup CharacterStyleGroup .getElements (

)

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

CharacterStyleGroup CharacterStyleGroups.add (
[withProperties:
Object]
)

CharacterStyleGroup CharacterStyleGroups.anyItem (

)

Array of CharacterStyleGroup CharacterStyleGroups.everyItem (

)

CharacterStyleGroup CharacterStyleGroups.firstItem (

)

CharacterStyleGroup CharacterStyleGroups.item (
index:
any
)

CharacterStyleGroup CharacterStyleGroups.itemByID (
id:
number
)

CharacterStyleGroup CharacterStyleGroups.itemByName (
name:
string
)

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

CharacterStyleGroup CharacterStyleGroups.lastItem (

)

CharacterStyleGroup CharacterStyleGroups.middleItem (

)

CharacterStyleGroup CharacterStyleGroups.nextItem (
obj:
CharacterStyleGroup
)

CharacterStyleGroup CharacterStyleGroups.previousItem (
obj:
CharacterStyleGroup
)