Adobe InDesign CS2 (4.0) Object Model JS: InsertionPoints

InDesign CS2

Class

InsertionPoints

 A collection of insertion points.

QuickLinks

anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

InsertionPoint anyItem ()
Returns any InsertionPoint in the collection.

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

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

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

InsertionPoint item (index: any)
Returns the InsertionPoint with the specified index or name.

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

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

ParameterTypeDescription
namestringThe name.

Array of InsertionPoint itemByRange (from: any, to: any)
Returns the InsertionPoints within the specified range.

ParameterTypeDescription
fromInsertionPoint
Long
String
The InsertionPoint, index, or name at the beginning of the range. Can accept: InsertionPoint, Long or String.
toInsertionPoint
Long
String
The InsertionPoint, index, or name at the end of the range. Can accept: InsertionPoint, Long or String.

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

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

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

ParameterTypeDescription
objInsertionPointThe InsertionPoint whose index comes before the desired InsertionPoint.

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

ParameterTypeDescription
objInsertionPointThe index of the InsertionPoint that follows the desired InsertionPoint.

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

Element of

Cell.insertionPoints

Character.insertionPoints

Footnote.insertionPoints

InsertionPoint.insertionPoints

Line.insertionPoints

Note.insertionPoints

Paragraph.insertionPoints

Story.insertionPoints

Text.insertionPoints

TextColumn.insertionPoints

TextFrame.insertionPoints

TextPath.insertionPoints

TextStyleRange.insertionPoints

Word.insertionPoints

XMLElement.insertionPoints

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