LayoutSections

A collection of sections.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

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