Adobe InDesign CS6 (8.0) Object Model JS: GraphicLines

InDesign CS6

Class

GraphicLines

 A collection of graphic lines.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

GraphicLine add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new GraphicLine

ParameterTypeDescription
layerLayerThe layer on which to create the GraphicLine. (Optional)
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location at which to insert the GraphicLine relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
Layer
MasterSpread
Page
PageItem
Spread
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withPropertiesObjectInitial 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.

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

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

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

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

GraphicLine itemByID (id: number)
Returns the GraphicLine with the specified ID.

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

ParameterTypeDescription
objGraphicLineThe GraphicLine whose index comes before the desired GraphicLine.

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

ParameterTypeDescription
objGraphicLineThe index of the GraphicLine that follows the desired GraphicLine.

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

Element of

Button.graphicLines

Cell.graphicLines

Character.graphicLines

CheckBox.graphicLines

ComboBox.graphicLines

Document.graphicLines

Footnote.graphicLines

GraphicLine.graphicLines

Group.graphicLines

InsertionPoint.graphicLines

Layer.graphicLines

Line.graphicLines

ListBox.graphicLines

MasterSpread.graphicLines

MultiStateObject.graphicLines

Oval.graphicLines

Page.graphicLines

Paragraph.graphicLines

PlaceGun.graphicLines

Polygon.graphicLines

RadioButton.graphicLines

Rectangle.graphicLines

SignatureField.graphicLines

Snippet.graphicLines

SplineItem.graphicLines

Spread.graphicLines

State.graphicLines

Story.graphicLines

Table.graphicLines

Text.graphicLines

TextBox.graphicLines

TextColumn.graphicLines

TextFrame.graphicLines

TextStyleRange.graphicLines

Word.graphicLines

XmlStory.graphicLines

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