Sections
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Section [] (index:
number)
Returns the Section with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Section add ([reference:
Page][, withProperties:
Object])
Creates a new section.
| Parameter | Type | Description |
|---|---|---|
| reference | Page | The page on which the section begins. (Optional) |
| withProperties | Object | 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.
Array of Section everyItem ()
Returns every Section in the collection.
Section firstItem ()
Returns the first Section in the collection.
Section item (index:
any)
Returns the Section with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | 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 | number | The ID. |
Section itemByName (name:
string)
Returns the Section with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of Section itemByRange (from:
any, to:
any)
Returns the Sections within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer Section String | The Section, index, or name at the beginning of the range. Can accept: Section, Long Integer or String. |
| to | Long Integer Section String | 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 | Section | 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 | Section | The index of the Section that follows the desired Section. |
string toSource ()
Generates a string which, if executed, will return the Section.
Element of
Document.sections
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |