GraphicLines

A collection of graphic lines.

Go to Property Listing | Method Listing

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 [] (index:Number)

Returns the GraphicLine with the specified index.

Parameter	Type	Description
index	Number	The index.

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

Creates 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	The location at which to insert the GraphicLine relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
reference	Document Layer MasterSpread Page Spread PageItem	The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (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 LongInteger String)

Returns the GraphicLine with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer 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 LongInteger String, to:Varies GraphicLine LongInteger String)

Returns the GraphicLines within the specified range.

Parameter	Type	Description
from	GraphicLine LongInteger String	The GraphicLine, index, or name at the beginning of the range. Can accept: GraphicLine, Long Integer or String.
to	GraphicLine LongInteger String	The GraphicLine, index, or name at the end of the range. Can accept: GraphicLine, Long Integer or String.

Parameter

Type

Description

from

GraphicLine

LongInteger

String

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

GraphicLine

LongInteger

String

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

PlaceGun.graphicLines

Document.graphicLines

Button.graphicLines

State.graphicLines

MultiStateObject.graphicLines

CheckBox.graphicLines

ComboBox.graphicLines

ListBox.graphicLines

RadioButton.graphicLines

TextBox.graphicLines

SignatureField.graphicLines

Layer.graphicLines

Spread.graphicLines

Page.graphicLines

MasterSpread.graphicLines

Oval.graphicLines

Rectangle.graphicLines

GraphicLine.graphicLines

Polygon.graphicLines

Group.graphicLines

SplineItem.graphicLines

Snippet.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

EndnoteTextFrame.graphicLines

Footnote.graphicLines

XmlStory.graphicLines