A collection of groups.
Go to Property Listing | Method Listing
add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Group add (groupItems:Array of PageItem, layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document MasterSpread Page Spread Layer, withProperties:Object)
Create a new Group
|
Parameter |
Type |
Description |
|---|---|---|
|
groupItems |
A list of page items to group |
|
|
layer |
The layer on which to create the Group (Optional) |
|
|
at |
Location (Optional) (default: LocationOptions.UNKNOWN) |
|
|
reference |
Before/after this Group or at the beginning/end of this Document, Spread, Master Spread, Page or Layer. Can accept: Document, Spread, MasterSpread, Page or Layer. (Optional) |
|
|
withProperties |
Initial 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.
Group everyItem ()
Returns every Group in the collection.
Group firstItem ()
Returns the first Group in the collection.
Group item (index:Varies Long String)
Returns the Group with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
Long |
The index or name. Can accept: Long or String. |
Group itemByID (id:Number)
Returns the Group with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Group itemByName (name:String)
Returns the Group with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Group itemByRange (from:Varies Group Long String, to:Varies Group Long String)
Returns the Groups within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
Long |
The Group, index, or name at the beginning of the range. Can accept: Group, Long or String. |
|
to |
Long |
The Group, index, or name at the end of the range. Can accept: Group, Long 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.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Group whose index comes before the desired Group. |
Group previousItem (obj:Group)
Returns the Group with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Group that follows the desired Group. |
String toSource ()
Generates a string which, if executed, will return the Group.
Document.groups
Button.groups
State.groups
Layer.groups
Spread.groups
Page.groups
MasterSpread.groups
PageItem.groups
Oval.groups
Rectangle.groups
GraphicLine.groups
Polygon.groups
Group.groups
Cell.groups
Table.groups
Text.groups
Character.groups
Word.groups
Line.groups
TextColumn.groups
Paragraph.groups
TextStyleRange.groups
InsertionPoint.groups
TextFrame.groups
Story.groups
Footnote.groups