ParagraphStyleGroup

A paragraph style group.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, ParagraphStyle, ParagraphStyleGroups, ParagraphStyles, Preferences, String, TypefiStyleSettings

Preferences:

Preferences

Property Listing

Property

Type

Access

Description

allParagraphStyles

Array of ParagraphStyle

readonly

Lists all paragraph styles (regardless of their group).

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 ParagraphStyleGroup.

index

Number

readonly

The index of the ParagraphStyleGroup 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 ParagraphStyleGroup.

paragraphStyleGroups

ParagraphStyleGroups ParagraphStyleGroup

readonly

A collection of paragraph style groups.

paragraphStyles

ParagraphStyles ParagraphStyle

readonly

A collection of paragraph styles.

parent

Application

Document

ParagraphStyleGroup

readonly

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

preferences

Preferences Preference

readonly

A collection of preferences objects.

properties

Object

read/write

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

typefiSettings

TypefiStyleSettings

readonly

Typefi specific settings to styles

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)

ParagraphStyleGroup duplicate ()

Duplicates the ParagraphStyleGroup.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

ParagraphStyleGroup 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.

ParagraphStyleGroup 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 ParagraphStyleGroup.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

ParagraphStyle.parent

ParagraphStyleGroup.parent

Preference.parent

TypefiStyleSettings.parent

Return

ParagraphStyleGroups.add()

ParagraphStyleGroup.duplicate()

ParagraphStyleGroup.move()

ParagraphStyleGroup.getElements()

ParagraphStyleGroups.anyItem()

ParagraphStyleGroups.everyItem()

ParagraphStyleGroups.nextItem()

ParagraphStyleGroups.previousItem()

ParagraphStyleGroups.itemByID()

ParagraphStyleGroups.item()

ParagraphStyleGroups.[]()

ParagraphStyleGroups.itemByName()

ParagraphStyleGroups.itemByRange()

ParagraphStyleGroups.firstItem()

ParagraphStyleGroups.lastItem()

ParagraphStyleGroups.middleItem()