Adobe InDesign CS5 Server (7.0) Object Model JS: Guides

InDesign Server CS5

Class

Guides

 A collection of guides.

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

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

ParameterTypeDescription
indexnumberThe index.

Guide add ([layer: Layer][, withProperties: Object])
Creates a new guide.

ParameterTypeDescription
layerLayerThe layer on which to create the guide. (Optional)
withPropertiesObjectInitial values for properties of the new Guide (Optional)

Guide anyItem ()
Returns any Guide in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromGuide
Long Integer
String
The Guide, index, or name at the beginning of the range. Can accept: Guide, Long Integer or String.
toGuide
Long Integer
String
The Guide, index, or name at the end of the range. Can accept: Guide, Long Integer or String.

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

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

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

ParameterTypeDescription
objGuideThe Guide whose index comes before the desired Guide.

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

ParameterTypeDescription
objGuideThe index of the Guide that follows the desired Guide.

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

Element of

Document.guides

Layer.guides

MasterSpread.guides

Page.guides

Page.masterPageItems

Spread.guides

Jongware, 23-Mar-2011 v3.0.3dContents :: Index