Class

Lines

 A collection of lines.

See also Line.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

Line anyItem ()
Returns any Line in the collection.

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

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

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

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

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

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

ParameterTypeDescription
fromLine
Long Integer
String		The Line, index, or name at the beginning of the range. Can accept: Line, Long Integer or String.
toLine
Long Integer
String		The Line, index, or name at the end of the range. Can accept: Line, Long Integer or String.

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

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

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

ParameterTypeDescription
objLineThe Line whose index comes before the desired Line.

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

ParameterTypeDescription
objLineThe index of the Line that follows the desired Line.

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

Element of

Cell.lines

Change.lines

Character.lines

Footnote.lines

HiddenText.lines

InsertionPoint.lines

Line.lines

Note.lines

Paragraph.lines

Story.lines

Text.lines

TextColumn.lines

TextFrame.lines

TextPath.lines

TextStyleRange.lines

Word.lines

XMLElement.lines

XmlStory.lines

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