Adobe InDesign CS2 (4.0) Object Model JS: ShowHideFieldsBehavior

InDesign CS2

Class

ShowHideFieldsBehavior

 A show/hide fields behavior object. Base Class: Behavior

QuickLinks

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Hierarchy

Button | FormField
Behavior
ShowHideFieldsBehavior

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.
fieldsToHide Array of FormField r/wThe hidden interactive objects.
fieldsToShow Array of FormField r/wThe visible interactive objects.
idnumber readonlyThe unique ID of the ShowHideFieldsBehavior.
indexnumber readonlyThe index of the ShowHideFieldsBehavior within its containing object.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the ShowHideFieldsBehavior.
parentButton
FormField
readonlyThe parent of the ShowHideFieldsBehavior (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 ShowHideFieldsBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of ShowHideFieldsBehavior ShowHideFieldsBehaviors.itemByRange (from: any, to: any)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.nextItem (obj: ShowHideFieldsBehavior)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.previousItem (obj: ShowHideFieldsBehavior)

Return

ShowHideFieldsBehavior ShowHideFieldsBehaviors.add ([withProperties: Object])

ShowHideFieldsBehavior ShowHideFieldsBehaviors.anyItem ()

Array of ShowHideFieldsBehavior ShowHideFieldsBehaviors.everyItem ()

ShowHideFieldsBehavior ShowHideFieldsBehaviors.firstItem ()

ShowHideFieldsBehavior ShowHideFieldsBehaviors.item (index: any)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.itemByID (id: number)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.itemByName (name: string)

Array of ShowHideFieldsBehavior ShowHideFieldsBehaviors.itemByRange (from: any, to: any)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.lastItem ()

ShowHideFieldsBehavior ShowHideFieldsBehaviors.middleItem ()

ShowHideFieldsBehavior ShowHideFieldsBehaviors.nextItem (obj: ShowHideFieldsBehavior)

ShowHideFieldsBehavior ShowHideFieldsBehaviors.previousItem (obj: ShowHideFieldsBehavior)

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