GraphicLines

A collection of graphic lines.

Methods:

add, anyItem, count, everyItem, firstItem, item, itemByID, 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

GraphicLine add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document MasterSpread Page Spread Layer, withProperties:Object)

Create a new GraphicLine

Parameter

Type

Description

layer

Layer

The layer on which to create the GraphicLine. (Optional)

at

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

Location (Optional)

(default: LocationOptions.UNKNOWN)

reference

Document

MasterSpread

Page

Spread

Layer

Before/after this GraphicLine or at the beginning/end of this Document, Spread, Master Spread, Page or Layer. Can accept: Document, Spread, MasterSpread, Page or Layer. (Optional)

withProperties

Object

Initial values for properties of the new GraphicLine (Optional)

GraphicLine anyItem ()

Returns any GraphicLine in the collection.

Number count ()

Displays the number of elements in the GraphicLine.

GraphicLine everyItem ()

Returns every GraphicLine in the collection.

GraphicLine firstItem ()

Returns the first GraphicLine in the collection.

GraphicLine item (index:Varies Long String)

Returns the GraphicLine with the specified index or name.

Parameter

Type

Description

index

Long

String

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

GraphicLine itemByID (id:Number)

Returns the GraphicLine with the specified ID.

Parameter

Type

Description

id

Number

The ID.

GraphicLine itemByName (name:String)

Returns the GraphicLine with the specified name.

Parameter

Type

Description

name

String

The name.

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

Returns the GraphicLines within the specified range.

Parameter

Type

Description

from

GraphicLine

Long

String

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

to

GraphicLine

Long

String

The GraphicLine, index, or name at the end of the range. Can accept: GraphicLine, Long or String.

GraphicLine lastItem ()

Returns the last GraphicLine in the collection.

GraphicLine middleItem ()

Returns the middle GraphicLine in the collection.

GraphicLine nextItem (obj:GraphicLine)

Returns the GraphicLine whose index follows the specified GraphicLine in the collection.

Parameter

Type

Description

obj

GraphicLine

The GraphicLine whose index comes before the desired GraphicLine.

GraphicLine previousItem (obj:GraphicLine)

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

Parameter

Type

Description

obj

GraphicLine

The index of the GraphicLine that follows the desired GraphicLine.

String toSource ()

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

Object of

Document.graphicLines

Button.graphicLines

State.graphicLines

Layer.graphicLines

Spread.graphicLines

Page.graphicLines

MasterSpread.graphicLines

PageItem.graphicLines

Oval.graphicLines

Rectangle.graphicLines

GraphicLine.graphicLines

Polygon.graphicLines

Group.graphicLines

Cell.graphicLines

Table.graphicLines

Text.graphicLines

Character.graphicLines

Word.graphicLines

Line.graphicLines

TextColumn.graphicLines

Paragraph.graphicLines

TextStyleRange.graphicLines

InsertionPoint.graphicLines

TextFrame.graphicLines

Story.graphicLines

Footnote.graphicLines