Adobe InCopy CS6 (8.0) Object Model JS: ParagraphStyleGroup

InCopy CS6

Class

ParagraphStyleGroup

 A paragraph style group.

QuickLinks

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

Hierarchy

Application | Document | ParagraphStyleGroup
ParagraphStyleGroup
Event | EventListener | MutationEvent | ParagraphStyle | ParagraphStyleGroup

Properties

PropertyTypeAccessDescription
allParagraphStyles Array of ParagraphStyle readonlyLists all paragraph styles (regardless of their group).
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the ParagraphStyleGroup.
indexnumber readonlyThe index of the ParagraphStyleGroup within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the ParagraphStyleGroup.
paragraphStyleGroupsParagraphStyleGroups ParagraphStyleGroup readonlyA collection of paragraph style groups.
paragraphStylesParagraphStyles ParagraphStyle readonlyA collection of paragraph styles.
parentApplicationDocument
ParagraphStyleGroup
readonlyThe parent of the ParagraphStyleGroup (a Document, Application or ParagraphStyleGroup).
propertiesObject r/wA 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

ParagraphStyleGroup duplicate ()
Duplicates the ParagraphStyleGroup.

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

ParameterTypeDescription
keystringThe key.

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

ParameterTypeDescription
keystringThe key.
valuestringThe value.

ParagraphStyleGroup move (to: LocationOptions[, reference: varies])
Moves the style to the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceApplication
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.

ParameterTypeDescription
replacingWithCharacterStyle
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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

ParagraphStyle.parent

ParagraphStyleGroup.parent

Used in:

ParagraphStyleGroup ParagraphStyleGroups.nextItem (obj: ParagraphStyleGroup)

ParagraphStyleGroup ParagraphStyleGroups.previousItem (obj: ParagraphStyleGroup)

Return

ParagraphStyleGroup ParagraphStyleGroup.duplicate ()

Array of ParagraphStyleGroup ParagraphStyleGroup.getElements ()

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

ParagraphStyleGroup ParagraphStyleGroups.[] (index: number)

ParagraphStyleGroup ParagraphStyleGroups.add ([withProperties: Object])

ParagraphStyleGroup ParagraphStyleGroups.anyItem ()

Array of ParagraphStyleGroup ParagraphStyleGroups.everyItem ()

ParagraphStyleGroup ParagraphStyleGroups.firstItem ()

ParagraphStyleGroup ParagraphStyleGroups.item (index: varies)

ParagraphStyleGroup ParagraphStyleGroups.itemByID (id: number)

ParagraphStyleGroup ParagraphStyleGroups.itemByName (name: string)

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

ParagraphStyleGroup ParagraphStyleGroups.lastItem ()

ParagraphStyleGroup ParagraphStyleGroups.middleItem ()

ParagraphStyleGroup ParagraphStyleGroups.nextItem (obj: ParagraphStyleGroup)

ParagraphStyleGroup ParagraphStyleGroups.previousItem (obj: ParagraphStyleGroup)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index