Adobe InDesign CS2 (4.0) Object Model JS: OpenFileBehavior

InDesign CS2

Class

OpenFileBehavior

 An open file behavior object. Base Class: Behavior

QuickLinks

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Hierarchy

Button | FormField
Behavior
OpenFileBehavior

Properties

PropertyTypeAccessDescription
enableBehaviorbool r/wIf true, the behavior is enabled.
eventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
r/wThe event that triggers the behavior.
filePathFile r/wThe full path to the file.
idnumber readonlyThe unique ID of the OpenFileBehavior.
indexnumber readonlyThe index of the OpenFileBehavior within its containing object.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the OpenFileBehavior.
parentButton
FormField
readonlyThe parent of the OpenFileBehavior (a FormField or Button).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Object getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the OpenFileBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of OpenFileBehavior OpenFileBehaviors.itemByRange (from: any, to: any)

OpenFileBehavior OpenFileBehaviors.nextItem (obj: OpenFileBehavior)

OpenFileBehavior OpenFileBehaviors.previousItem (obj: OpenFileBehavior)

Return

OpenFileBehavior OpenFileBehaviors.add ([withProperties: Object])

OpenFileBehavior OpenFileBehaviors.anyItem ()

Array of OpenFileBehavior OpenFileBehaviors.everyItem ()

OpenFileBehavior OpenFileBehaviors.firstItem ()

OpenFileBehavior OpenFileBehaviors.item (index: any)

OpenFileBehavior OpenFileBehaviors.itemByID (id: number)

OpenFileBehavior OpenFileBehaviors.itemByName (name: string)

Array of OpenFileBehavior OpenFileBehaviors.itemByRange (from: any, to: any)

OpenFileBehavior OpenFileBehaviors.lastItem ()

OpenFileBehavior OpenFileBehaviors.middleItem ()

OpenFileBehavior OpenFileBehaviors.nextItem (obj: OpenFileBehavior)

OpenFileBehavior OpenFileBehaviors.previousItem (obj: OpenFileBehavior)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index