Groups
A collection of groups.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
Group [] (index:Number)
Returns the Group with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Group add (groupItems:Array of PageItem, layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document Layer MasterSpread Page Spread PageItem, withProperties:Object)
Creates a new Group.
|
Parameter |
Type |
Description |
|---|---|---|
|
groupItems |
The objects to group. |
|
|
layer |
The layer on which to create the Group. (Optional) |
|
|
at |
The location at which to insert the Group relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN) |
|
|
reference |
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (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 LongInteger String)
Returns the Group with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
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 |
The ID. |
Group itemByName (name:String)
Returns the Group with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Group itemByRange (from:Varies Group LongInteger String, to:Varies Group LongInteger String)
Returns the Groups within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The Group, index, or name at the beginning of the range. Can accept: Group, Long Integer or String. |
|
to |
LongInteger |
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 |
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.
Object of
PlaceGun.groups
Document.groups
Button.groups
State.groups
MultiStateObject.groups
CheckBox.groups
ComboBox.groups
ListBox.groups
RadioButton.groups
TextBox.groups
SignatureField.groups
Layer.groups
Spread.groups
Page.groups
MasterSpread.groups
Oval.groups
Rectangle.groups
GraphicLine.groups
Polygon.groups
Group.groups
SplineItem.groups
Snippet.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
EndnoteTextFrame.groups
Footnote.groups
XmlStory.groups