Groups
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Group [] (index:
number)
Returns the Group with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Group add (groupItems:
Array of PageItem[, layer:
Layer][, at:
LocationOptions=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: 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) |
| reference | Document 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) |
| withProperties | Object | 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.
Array of Group everyItem ()
Returns every Group in the collection.
Group firstItem ()
Returns the first Group in the collection.
Group item (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. |
Group itemByID (id:
number)
Returns the Group with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
Group itemByName (name:
string)
Returns the Group with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of Group itemByRange (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. |
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 | Group | 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 | 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
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |