Adobe InCopy CS6 (8.0) Object Model JS: SubmitFormBehavior

InCopy CS6

Class

SubmitFormBehavior

 A behavior object that submits the document. Base Class: Behavior

QuickLinks

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

Hierarchy

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

Properties

PropertyTypeAccessDescription
behaviorEventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
readonlyThe event which triggers the behavior.
enableBehaviorbool readonlyIf true, the behavior is enabled.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the SubmitFormBehavior.
indexnumber readonlyThe index of the SubmitFormBehavior 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 SubmitFormBehavior.
parentButton
CheckBox
ComboBox
ListBox
RadioButton
SignatureField
TextBox
readonlyThe parent of the SubmitFormBehavior (a Button, CheckBox, ComboBox, ListBox, RadioButton, TextBox or SignatureField).
propertiesObject r/wA property that allows setting of several properties at the same time.
urlstring readonlyThe URL.

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 SubmitFormBehavior 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.

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 SubmitFormBehavior.

string toSpecifier ()
Retrieves the object specifier.

Used in:

SubmitFormBehavior SubmitFormBehaviors.nextItem (obj: SubmitFormBehavior)

SubmitFormBehavior SubmitFormBehaviors.previousItem (obj: SubmitFormBehavior)

Return

Array of SubmitFormBehavior SubmitFormBehavior.getElements ()

SubmitFormBehavior SubmitFormBehaviors.[] (index: number)

SubmitFormBehavior SubmitFormBehaviors.anyItem ()

Array of SubmitFormBehavior SubmitFormBehaviors.everyItem ()

SubmitFormBehavior SubmitFormBehaviors.firstItem ()

SubmitFormBehavior SubmitFormBehaviors.item (index: varies)

SubmitFormBehavior SubmitFormBehaviors.itemByID (id: number)

SubmitFormBehavior SubmitFormBehaviors.itemByName (name: string)

Array of SubmitFormBehavior SubmitFormBehaviors.itemByRange (from: varies, to: varies)

SubmitFormBehavior SubmitFormBehaviors.lastItem ()

SubmitFormBehavior SubmitFormBehaviors.middleItem ()

SubmitFormBehavior SubmitFormBehaviors.nextItem (obj: SubmitFormBehavior)

SubmitFormBehavior SubmitFormBehaviors.previousItem (obj: SubmitFormBehavior)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index