Adobe InDesign CS3 (5.0) Object Model JS: NumberingList

InDesign CS3

Class

NumberingList

 A numbered list.

QuickLinks

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Hierarchy

Application | Document
NumberingList

Properties

PropertyTypeAccessDescription
continueNumbersAcrossDocumentsbool r/wif true, numbering will continue across book documents.
continueNumbersAcrossStoriesbool r/wIf true, numbering will continue across stories.
idnumber readonlyThe unique ID of the NumberingList.
indexnumber readonlyThe index of the NumberingList within its containing object.
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

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)

string toSource ()
Generates a string which, if executed, will return the NumberingList.

string toSpecifier ()
Retrieves the object specifier.

Element of

ChangeGrepPreference.appliedNumberingList

ChangeTextPreference.appliedNumberingList

Character.appliedNumberingList

FindGrepPreference.appliedNumberingList

FindTextPreference.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])

array of NumberingList NumberingLists.itemByRange (from: any, to: any)

NumberingList NumberingLists.nextItem (obj: NumberingList)

NumberingList NumberingLists.previousItem (obj: NumberingList)

Return

Array of NumberingList NumberingList.getElements ()

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: any)

NumberingList NumberingLists.itemByID (id: number)

NumberingList NumberingLists.itemByName (name: string)

Array of NumberingList NumberingLists.itemByRange (from: any, to: any)

NumberingList NumberingLists.lastItem ()

NumberingList NumberingLists.middleItem ()

NumberingList NumberingLists.nextItem (obj: NumberingList)

NumberingList NumberingLists.previousItem (obj: NumberingList)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index