NumberingList
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| continueNumbersAcrossDocuments | bool | r/w | if true, numbering will continue across book documents. |
| continueNumbersAcrossStories | bool | r/w | If true, numbering will continue across stories. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| id | number | readonly | The unique ID of the NumberingList. |
| index | number | readonly | The index of the NumberingList 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. |
| name | string | r/w | The name of the NumberingList. |
| parent | ApplicationDocument | readonly | The parent of the NumberingList (a Application or Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
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 NumberingList 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 ([replacingWith:
NumberingList])
Delete the NumberingList.
| Parameter | Type | Description |
|---|---|---|
| replacingWith | NumberingList | The NumberingList to apply in place of this one. (Optional) |
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 NumberingList.
string toSpecifier ()
Retrieves the object specifier.
Element of
ChangeGrepPreference.appliedNumberingList
ChangeTextPreference.appliedNumberingList
ChangeTransliteratePreference.appliedNumberingList
Character.appliedNumberingList
FindGrepPreference.appliedNumberingList
FindTextPreference.appliedNumberingList
FindTransliteratePreference.appliedNumberingList
InsertionPoint.appliedNumberingList
Line.appliedNumberingList
Paragraph.appliedNumberingList
ParagraphStyle.appliedNumberingList
Story.appliedNumberingList
Text.appliedNumberingList
TextColumn.appliedNumberingList
TextDefault.appliedNumberingList
TextStyleRange.appliedNumberingList
Word.appliedNumberingList
XmlStory.appliedNumberingList
Used in:
void NumberingList.remove ([replacingWith: NumberingList])
NumberingList NumberingLists.nextItem (obj: NumberingList)
NumberingList NumberingLists.previousItem (obj: NumberingList)
Return
Array of NumberingList NumberingList.getElements ()
NumberingList NumberingLists.[] (index: number)
NumberingList NumberingLists.add (name: string[, continueNumbersAcrossStories: bool][, continueNumbersAcrossDocuments: bool][, withProperties: Object])
NumberingList NumberingLists.anyItem ()
Array of NumberingList NumberingLists.everyItem ()
NumberingList NumberingLists.firstItem ()
NumberingList NumberingLists.item (index: varies)
NumberingList NumberingLists.itemByID (id: number)
NumberingList NumberingLists.itemByName (name: string)
Array of NumberingList NumberingLists.itemByRange (from: varies, to: varies)
NumberingList NumberingLists.lastItem ()
NumberingList NumberingLists.middleItem ()
NumberingList NumberingLists.nextItem (obj: NumberingList)
NumberingList NumberingLists.previousItem (obj: NumberingList)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |