Adobe InDesign CS6 (8.0) Object Model JS: ParagraphStyleGroups

InDesign CS6

Class

ParagraphStyleGroups

 A collection of paragraph style groups.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

ParagraphStyleGroup [] (index: number)
Returns the ParagraphStyleGroup with the specified index.

ParameterTypeDescription
indexnumberThe index.

ParagraphStyleGroup add ([withProperties: Object])
Creates a new ParagraphStyleGroup.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new ParagraphStyleGroup (Optional)

ParagraphStyleGroup anyItem ()
Returns any ParagraphStyleGroup in the collection.

number count ()
Displays the number of elements in the ParagraphStyleGroup.

Array of ParagraphStyleGroup everyItem ()
Returns every ParagraphStyleGroup in the collection.

ParagraphStyleGroup firstItem ()
Returns the first ParagraphStyleGroup in the collection.

ParagraphStyleGroup item (index: varies)
Returns the ParagraphStyleGroup with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

ParagraphStyleGroup itemByID (id: number)
Returns the ParagraphStyleGroup with the specified ID.

ParameterTypeDescription
idnumberThe ID.

ParagraphStyleGroup itemByName (name: string)
Returns the ParagraphStyleGroup with the specified name.

ParameterTypeDescription
namestringThe name.

Array of ParagraphStyleGroup itemByRange (from: varies, to: varies)
Returns the ParagraphStyleGroups within the specified range.

ParameterTypeDescription
fromLong Integer
ParagraphStyleGroup
String
The ParagraphStyleGroup, index, or name at the beginning of the range. Can accept: ParagraphStyleGroup, Long Integer or String.
toLong Integer
ParagraphStyleGroup
String
The ParagraphStyleGroup, index, or name at the end of the range. Can accept: ParagraphStyleGroup, Long Integer or String.

ParagraphStyleGroup lastItem ()
Returns the last ParagraphStyleGroup in the collection.

ParagraphStyleGroup middleItem ()
Returns the middle ParagraphStyleGroup in the collection.

ParagraphStyleGroup nextItem (obj: ParagraphStyleGroup)
Returns the ParagraphStyleGroup whose index follows the specified ParagraphStyleGroup in the collection.

ParameterTypeDescription
objParagraphStyleGroupThe ParagraphStyleGroup whose index comes before the desired ParagraphStyleGroup.

ParagraphStyleGroup previousItem (obj: ParagraphStyleGroup)
Returns the ParagraphStyleGroup with the index previous to the specified index.

ParameterTypeDescription
objParagraphStyleGroupThe index of the ParagraphStyleGroup that follows the desired ParagraphStyleGroup.

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

Element of

Application.paragraphStyleGroups

Document.paragraphStyleGroups

ParagraphStyleGroup.paragraphStyleGroups

Jongware, 28-Apr-2012 v3.0.3hContents :: Index