Adobe InCopy CS6 (8.0) Object Model JS: NumberingList

InCopy CS6

Class

NumberingList

 A numbered list.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
NumberingList
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
continueNumbersAcrossDocumentsbool r/wif true, numbering will continue across book documents.
continueNumbersAcrossStoriesbool r/wIf true, numbering will continue across stories.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the NumberingList.
indexnumber readonlyThe index of the NumberingList within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the NumberingList.
parentApplicationDocument readonlyThe parent of the NumberingList (a Application or Document).
propertiesObject r/wA 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ([replacingWith: NumberingList])
Delete the NumberingList.

ParameterTypeDescription
replacingWithNumberingListThe NumberingList to apply in place of this one. (Optional)

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis 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, 29-Apr-2012 v3.0.3iContents :: Index