A layout section.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| continueNumbering | bool | r/w | If true, continues page numbers sequentially from the previous section. |
| id | number | readonly | The unique ID of the Section. |
| includeSectionPrefix | bool | r/w | If true, places the specified prefix before page numbers on all pages in the section. For information on specifying the prefix, see section prefix. |
| index | number | readonly | The index of the Section within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| length | number | readonly | The number of pages in the section. |
| marker | string | r/w | The section marker. |
| name | string | r/w | The name of the Section. |
| pageNumberStart | number | r/w | The page number assigned to the first page in the section. Note: Valid only when continue numbering is false. |
| pageNumberStyle | PageNumberStyle : UPPER_ROMAN LOWER_ROMAN UPPER_LETTERS LOWER_LETTERS ARABIC |
r/w | The page number format. |
| pageStart | Page | r/w | The start page for the section. |
| parent | Document | readonly | The parent of the Section (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| sectionPrefix | string | r/w | The prefix to place before page numbers on pages in the section. May include up to 8 characters. Note: Valid only when include section prefix is true. |
Methods
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of SectiongetElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the Section.
string toSource ()
Generates a string which, if executed, will return the Section.
string toSpecifier ()
Retrieves the object specifier.
Element of:
Page.appliedSection
Used in:
Sections.previousItem (
obj:
Section )
Sections.nextItem (
obj:
Section )
Returned by:
Array of Section Section .getElements (
)
Section Sections.add (
[reference:
Page][, withProperties:
Object]
)
Section Sections.anyItem (
)
Array of Section Sections.everyItem (
)
Section Sections.firstItem (
)
Section Sections.item (
index:
any
)
Section Sections.itemByID (
id:
number
)
Section Sections.itemByName (
name:
string
)
Array of Section Sections.itemByRange (
from:
any, to:
any
)
Section Sections.lastItem (
)
Section Sections.middleItem (
)
Section Sections.nextItem (
obj:
Section
)
Section Sections.previousItem (
obj:
Section
)