Adobe InDesign CS6 (8.0) Object Model JS: ClearFormBehavior

InDesign CS6

Class

ClearFormBehavior

 A behavior object that clears the form fields in the document. Base Class: Behavior

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Button | CheckBox | ComboBox | ListBox | RadioButton | SignatureField | TextBox
Behavior
ClearFormBehavior
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
behaviorEventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
r/wThe event which triggers the behavior.
enableBehaviorbool r/wIf true, the behavior is enabled.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the ClearFormBehavior.
indexnumber readonlyThe index of the ClearFormBehavior within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the ClearFormBehavior.
parentButton
CheckBox
ComboBox
ListBox
RadioButton
SignatureField
TextBox
readonlyThe parent of the ClearFormBehavior (a Button, CheckBox, ComboBox, ListBox, RadioButton, TextBox or SignatureField).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

ParameterTypeDescription
keystringThe key.

Array of ClearFormBehavior 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 ClearFormBehavior.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

ClearFormBehavior ClearFormBehaviors.nextItem (obj: ClearFormBehavior)

ClearFormBehavior ClearFormBehaviors.previousItem (obj: ClearFormBehavior)

Return

Array of ClearFormBehavior ClearFormBehavior.getElements ()

ClearFormBehavior ClearFormBehaviors.[] (index: number)

ClearFormBehavior ClearFormBehaviors.add ([withProperties: Object])

ClearFormBehavior ClearFormBehaviors.anyItem ()

Array of ClearFormBehavior ClearFormBehaviors.everyItem ()

ClearFormBehavior ClearFormBehaviors.firstItem ()

ClearFormBehavior ClearFormBehaviors.item (index: varies)

ClearFormBehavior ClearFormBehaviors.itemByID (id: number)

ClearFormBehavior ClearFormBehaviors.itemByName (name: string)

Array of ClearFormBehavior ClearFormBehaviors.itemByRange (from: varies, to: varies)

ClearFormBehavior ClearFormBehaviors.lastItem ()

ClearFormBehavior ClearFormBehaviors.middleItem ()

ClearFormBehavior ClearFormBehaviors.nextItem (obj: ClearFormBehavior)

ClearFormBehavior ClearFormBehaviors.previousItem (obj: ClearFormBehavior)

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