Adobe InCopy CS6 (8.0) Object Model JS: PrintFormBehavior

InCopy CS6

Class

PrintFormBehavior

 A behavior object that triggers print for the document. Base Class: Behavior

QuickLinks

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

Hierarchy

Button | CheckBox | ComboBox | ListBox | RadioButton | SignatureField | TextBox
Behavior
PrintFormBehavior
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 PrintFormBehavior.
indexnumber readonlyThe index of the PrintFormBehavior 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 PrintFormBehavior.
parentButton
CheckBox
ComboBox
ListBox
RadioButton
SignatureField
TextBox
readonlyThe parent of the PrintFormBehavior (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 PrintFormBehavior 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 PrintFormBehavior.

string toSpecifier ()
Retrieves the object specifier.

Used in:

PrintFormBehavior PrintFormBehaviors.nextItem (obj: PrintFormBehavior)

PrintFormBehavior PrintFormBehaviors.previousItem (obj: PrintFormBehavior)

Return

Array of PrintFormBehavior PrintFormBehavior.getElements ()

PrintFormBehavior PrintFormBehaviors.[] (index: number)

PrintFormBehavior PrintFormBehaviors.anyItem ()

Array of PrintFormBehavior PrintFormBehaviors.everyItem ()

PrintFormBehavior PrintFormBehaviors.firstItem ()

PrintFormBehavior PrintFormBehaviors.item (index: varies)

PrintFormBehavior PrintFormBehaviors.itemByID (id: number)

PrintFormBehavior PrintFormBehaviors.itemByName (name: string)

Array of PrintFormBehavior PrintFormBehaviors.itemByRange (from: varies, to: varies)

PrintFormBehavior PrintFormBehaviors.lastItem ()

PrintFormBehavior PrintFormBehaviors.middleItem ()

PrintFormBehavior PrintFormBehaviors.nextItem (obj: PrintFormBehavior)

PrintFormBehavior PrintFormBehaviors.previousItem (obj: PrintFormBehavior)

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