Class
Section |
| A section. |
QuickLinks |
extractLabel, insertLabel, remove |
Hierarchy
|
|
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. |
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 number at which to start numbering pages. 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. |
|
Methods
| Instancesstring extractLabel (key:
string)
Gets the label value associated with the specified key.
Parameter | Type | Description |
key | string | The key. |
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.
|
Element of |
Page.appliedSection
|
Used in: | Section Sections.add
([at:
LocationOptions=LocationOptions.UNKNOWN][, reference:
any][, withProperties:
Object])
|
Return |
Section Sections.add ([at:
LocationOptions=LocationOptions.UNKNOWN][, reference:
any][, withProperties:
Object])
|