Adobe InCopy CS6 (8.0) Object Model JS: NumberingLists

InCopy CS6

Class

NumberingLists

 A collection of numbered lists.

See also NumberingList.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

NumberingList [] (index: number)
Returns the NumberingList with the specified index.

ParameterTypeDescription
indexnumberThe index.

NumberingList add (name: string[, continueNumbersAcrossStories: bool][, continueNumbersAcrossDocuments: bool][, withProperties: Object])
Create a new list style.

ParameterTypeDescription
namestringName
continueNumbersAcrossStoriesboolIf true, numbering will continue across stories. (Optional)
continueNumbersAcrossDocumentsboolIf true, numbering will continue across book documents. (Optional)
withPropertiesObjectInitial values for properties of the new NumberingList (Optional)

NumberingList anyItem ()
Returns any NumberingList in the collection.

number count ()
Displays the number of elements in the NumberingList.

Array of NumberingList everyItem ()
Returns every NumberingList in the collection.

NumberingList firstItem ()
Returns the first NumberingList in the collection.

NumberingList item (index: varies)
Returns the NumberingList with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

NumberingList itemByID (id: number)
Returns the NumberingList with the specified ID.

ParameterTypeDescription
idnumberThe ID.

NumberingList itemByName (name: string)
Returns the NumberingList with the specified name.

ParameterTypeDescription
namestringThe name.

Array of NumberingList itemByRange (from: varies, to: varies)
Returns the NumberingLists within the specified range.

ParameterTypeDescription
fromLong Integer
NumberingList
String
The NumberingList, index, or name at the beginning of the range. Can accept: NumberingList, Long Integer or String.
toLong Integer
NumberingList
String
The NumberingList, index, or name at the end of the range. Can accept: NumberingList, Long Integer or String.

NumberingList lastItem ()
Returns the last NumberingList in the collection.

NumberingList middleItem ()
Returns the middle NumberingList in the collection.

NumberingList nextItem (obj: NumberingList)
Returns the NumberingList whose index follows the specified NumberingList in the collection.

ParameterTypeDescription
objNumberingListThe NumberingList whose index comes before the desired NumberingList.

NumberingList previousItem (obj: NumberingList)
Returns the NumberingList with the index previous to the specified index.

ParameterTypeDescription
objNumberingListThe index of the NumberingList that follows the desired NumberingList.

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

Element of

Application.numberingLists

Document.numberingLists

Jongware, 29-Apr-2012 v3.0.3iContents :: Index