Section
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| continueNumbering | bool | r/w | If true, continues page numbers sequentially from the previous section. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| 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. |
| index | number | readonly | The index of the Section within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| 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 (range: 1 - 999999) | r/w | The page number assigned to the first page in the section. Note: Valid only when continue numbering is false. |
| pageNumberStyle | PageNumberStyleString | r/w | The page number style. Can return: PageNumberStyle enumerator or String. |
| 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
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array
of Section getElements ()
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.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the Section.
Element of
Page.appliedSection
Used in:
Section Sections.nextItem (obj: Section)
Section Sections.previousItem (obj: Section)
Return
Array of Section Section.getElements ()
Section Sections.[] (index: number)
Section Sections.add ([reference: Page][, withProperties: Object])
Section Sections.anyItem ()
Array of Section Sections.everyItem ()
Section Sections.firstItem ()
Section Sections.item (index: varies)
Section Sections.itemByID (id: number)
Section Sections.itemByName (name: string)
Array of Section Sections.itemByRange (from: varies, to: varies)
Section Sections.lastItem ()
Section Sections.middleItem ()
Section Sections.nextItem (obj: Section)
Section Sections.previousItem (obj: Section)
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |