Sections
A collection of sections.
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
Section [] (index:Number)
Returns the Section with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Section add (reference:Page, withProperties:Object)
Creates a new section.
|
Parameter |
Type |
Description |
|---|---|---|
|
reference |
The page on which the section begins. (Optional) |
|
|
withProperties |
Initial values for properties of the new Section (Optional) |
Section anyItem ()
Returns any Section in the collection.
Number count ()
Displays the number of elements in the Section.
Section everyItem ()
Returns every Section in the collection.
Section firstItem ()
Returns the first Section in the collection.
Section item (index:Varies LongInteger String)
Returns the Section with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
Section itemByID (id:Number)
Returns the Section with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Section itemByName (name:String)
Returns the Section with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Section itemByRange (from:Varies LongInteger Section String, to:Varies LongInteger Section String)
Returns the Sections within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The Section, index, or name at the beginning of the range. Can accept: Section, Long Integer or String. |
|
to |
LongInteger |
The Section, index, or name at the end of the range. Can accept: Section, Long Integer or String. |
Section lastItem ()
Returns the last Section in the collection.
Section middleItem ()
Returns the middle Section in the collection.
Section nextItem (obj:Section)
Returns the Section whose index follows the specified Section in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Section whose index comes before the desired Section. |
Section previousItem (obj:Section)
Returns the Section with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Section that follows the desired Section. |
String toSource ()
Generates a string which, if executed, will return the Section.
Object of
Document.sections