Lines

A collection of lines.

Methods:

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

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Line anyItem ()

Returns any Line in the collection.

Number count ()

Displays the number of elements in the Line.

Line everyItem ()

Returns every Line in the collection.

Line firstItem ()

Returns the first Line in the collection.

Line item (index:Varies Long String)

Returns the Line with the specified index or name.

Parameter

Type

Description

index

Long

String

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

Line itemByName (name:String)

Returns the Line with the specified name.

Parameter

Type

Description

name

String

The name.

Line itemByRange (from:Varies Line Long String, to:Varies Line Long String)

Returns the Lines within the specified range.

Parameter

Type

Description

from

Line

Long

String

The Line, index, or name at the beginning of the range. Can accept: Line, Long or String.

to

Line

Long

String

The Line, index, or name at the end of the range. Can accept: Line, Long 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.

Parameter

Type

Description

obj

Line

The Line whose index comes before the desired Line.

Line previousItem (obj:Line)

Returns the Line with the index previous to the specified index.

Parameter

Type

Description

obj

Line

The index of the Line that follows the desired Line.

String toSource ()

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

Object of

Cell.lines

Text.lines

Character.lines

Word.lines

Line.lines

TextColumn.lines

Paragraph.lines

TextStyleRange.lines

InsertionPoint.lines

TextFrame.lines

Story.lines

TextPath.lines

Note.lines

Footnote.lines

XMLElement.lines