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

InDesign Server CS5

Class

GotoAnchorBehaviors

 A collection of goto anchor behavior objects.

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

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

ParameterTypeDescription
indexnumberThe index.

GotoAnchorBehavior add ([withProperties: Object])
Creates a new GotoAnchorBehavior.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new GotoAnchorBehavior (Optional)

GotoAnchorBehavior anyItem ()
Returns any GotoAnchorBehavior in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromGotoAnchorBehavior
Long Integer
String
The GotoAnchorBehavior, index, or name at the beginning of the range. Can accept: GotoAnchorBehavior, Long Integer or String.
toGotoAnchorBehavior
Long Integer
String
The GotoAnchorBehavior, index, or name at the end of the range. Can accept: GotoAnchorBehavior, Long Integer or String.

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

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

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

ParameterTypeDescription
objGotoAnchorBehaviorThe GotoAnchorBehavior whose index comes before the desired GotoAnchorBehavior.

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

ParameterTypeDescription
objGotoAnchorBehaviorThe index of the GotoAnchorBehavior that follows the desired GotoAnchorBehavior.

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

Element of

Button.gotoAnchorBehaviors

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