A collection of groups.
Methods
Groupadd (groupItems:
Array of PageItem[, layer:
Layer][, at:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object])
Creates a new Group.
| Parameter | Type | Description |
|---|---|---|
| groupItems | Array of PageItem | The objects to group. |
| layer | Layer | The layer on which to create the Group. (Optional) |
| at | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location at which to insert the Group relative to the reference object or within the container object. (Optional) (default: UNKNOWN ) |
| reference | Document Spread MasterSpread Page Layer PageItem |
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) |
| withProperties | Object | Initial values for properties of the new Group (Optional) |
GroupanyItem ()
Returns any Group in the collection.
number count ()
Displays the number of elements in the Group.
Array of GroupeveryItem ()
Returns every Group in the collection.
GroupfirstItem ()
Returns the first Group in the collection.
Groupitem (index:
any)
Returns the Group with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
GroupitemByID (id:
number)
Returns the Group with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
GroupitemByName (name:
string)
Returns the Group with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of GroupitemByRange (from:
any, to:
any)
Returns the Groups within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Group Long Integer String |
The Group, index, or name at the beginning of the range. Can accept: Group, Long Integer or String. |
| to | Group Long Integer String |
The Group, index, or name at the end of the range. Can accept: Group, Long Integer or String. |
GrouplastItem ()
Returns the last Group in the collection.
GroupmiddleItem ()
Returns the middle Group in the collection.
GroupnextItem (obj:
Group)
Returns the Group whose index follows the specified Group in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Group | The Group whose index comes before the desired Group. |
GrouppreviousItem (obj:
Group)
Returns the Group with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Group | The 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
Oval.groups
Page.groups
PageItem.groups
Paragraph.groups
Polygon.groups
Rectangle.groups
Spread.groups
State.groups
Story.groups
Table.groups
Text.groups
TextColumn.groups
TextFrame.groups
TextStyleRange.groups
Word.groups