Section
A section.
Go to Property Listing | Method Listing
Methods:
addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier
Objects:
Boolean, EventListeners, Events, Number, Object, Page, PageNumberStyle, String,
Property Listing
Property |
Type |
Access |
Description |
---|---|---|---|
read/write |
The alternate layout name for a set of pages. |
||
readonly |
The number of pages in the alternate layout section. |
||
read/write |
If true, continues page numbers sequentially from the previous section. |
||
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
readonly |
The unique ID of the Section. |
||
read/write |
If true, places the specified prefix before page numbers on all pages in the section. |
||
readonly |
The index of the Section within its containing object. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
read/write |
A property that can be set to any string. |
||
readonly |
The number of pages in the section. |
||
read/write |
The section marker. |
||
read/write |
The name of the Section. |
||
Number (range 1 - 999999) |
read/write |
The page number assigned to the first page in the section. Note: Valid only when continue numbering is false. |
|
read/write |
The page number style. Can return: PageNumberStyle enumerator or String. |
||
read/write |
The start page for the section. |
||
readonly |
The parent of the Section (a Document). |
||
read/write |
A property that allows setting of several properties at the same time. |
||
read/write |
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. |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
Parameter |
Type |
Description |
---|---|---|
key |
The key. |
Section getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
undefined remove ()
Deletes the Section.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the Section.
String toSpecifier ()
Retrieves the object specifier.
Object of
Page.appliedAlternateLayout
Event.parent
EventListener.parent
MutationEvent.parent
Page.appliedSection