ParagraphStyleGroup

A paragraph style group.

Properties

Property	Type	Access	Description
allParagraphStyles	Array of ParagraphStyle	readonly	Lists all paragraph styles (regardless of their group).
id	number	readonly	The unique ID of the ParagraphStyleGroup.
index	number	readonly	The index of the ParagraphStyleGroup 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 ParagraphStyleGroup.
paragraphStyleGroups	ParagraphStyleGroups	readonly	A collection of paragraph style groups.
paragraphStyles	ParagraphStyles	readonly	A collection of paragraph styles.
parent	any	readonly	The parent of the ParagraphStyleGroup (a Document, Application or ParagraphStyleGroup).
properties	Object	r/w	A property that allows setting of several properties at the same time.

Methods

ParagraphStyleGroupduplicate ()
Duplicates the ParagraphStyleGroup.

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

Parameter	Type	Description
key	string	The key.

Array of ParagraphStyleGroupgetElements ()
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.

ParagraphStyleGroupmove (to:
LocationOptions[, reference:
any])
Moves the ParagraphStyleGroup 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 ParagraphStyleGroup.

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

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

ParagraphStyleGroups.previousItem (

obj:
ParagraphStyleGroup )

ParagraphStyleGroups.nextItem (

obj:
ParagraphStyleGroup )

Returned by:

ParagraphStyleGroup ParagraphStyleGroup .duplicate (

)

Array of ParagraphStyleGroup ParagraphStyleGroup .getElements (

)

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

ParagraphStyleGroup ParagraphStyleGroups.add (
[withProperties:
Object]
)

ParagraphStyleGroup ParagraphStyleGroups.anyItem (

)

Array of ParagraphStyleGroup ParagraphStyleGroups.everyItem (

)

ParagraphStyleGroup ParagraphStyleGroups.firstItem (

)

ParagraphStyleGroup ParagraphStyleGroups.item (
index:
any
)

ParagraphStyleGroup ParagraphStyleGroups.itemByID (
id:
number
)

ParagraphStyleGroup ParagraphStyleGroups.itemByName (
name:
string
)

Array of ParagraphStyleGroup ParagraphStyleGroups.itemByRange (
from:
any, to:
any
)

ParagraphStyleGroup ParagraphStyleGroups.lastItem (

)

ParagraphStyleGroup ParagraphStyleGroups.middleItem (

)

ParagraphStyleGroup ParagraphStyleGroups.nextItem (
obj:
ParagraphStyleGroup
)

ParagraphStyleGroup ParagraphStyleGroups.previousItem (
obj:
ParagraphStyleGroup
)