Adobe InDesign CS5 (7.0) Object Model JS: Groups

InDesign CS5

Class

Groups

 A collection of 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

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

ParameterTypeDescription
indexnumberThe index.

Group add (groupItems: Array of PageItem[, layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new Group.

ParameterTypeDescription
groupItemsArray of PageItemThe objects to group.
layerLayerThe layer on which to create the Group. (Optional)
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location at which to insert the Group relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
Layer
MasterSpread
Page
PageItem
Spread
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withPropertiesObjectInitial values for properties of the new Group (Optional)

Group anyItem ()
Returns any Group in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromGroup
Long Integer
String
The Group, index, or name at the beginning of the range. Can accept: Group, Long Integer or String.
toGroup
Long Integer
String
The Group, index, or name at the end of the range. Can accept: Group, Long Integer or String.

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

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

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

ParameterTypeDescription
objGroupThe Group whose index comes before the desired Group.

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

ParameterTypeDescription
objGroupThe index of the Group that follows the desired Group.

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

Element of

Button.groups

Cell.groups

Character.groups

Document.groups

Footnote.groups

GraphicLine.groups

Group.groups

InsertionPoint.groups

Layer.groups

Line.groups

MasterSpread.groups

MultiStateObject.groups

Oval.groups

Page.groups

Paragraph.groups

PlaceGun.groups

Polygon.groups

Rectangle.groups

Snippet.groups

SplineItem.groups

Spread.groups

State.groups

Story.groups

Table.groups

Text.groups

TextColumn.groups

TextFrame.groups

TextStyleRange.groups

Word.groups

XmlStory.groups

Jongware, 20-Jun-2010 v3.0.3dContents :: Index