Adobe InCopy CS6 (8.0) Object Model JS: TextEditbox

InCopy CS6

Class

TextEditbox

 A text entry field. Base Class: Widget

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

BorderPanel | DialogColumn | DialogRow | EnablingGroup
Widget
TextEditbox
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
editContentsstring r/wThe default value in an editbox control. Note: Do not specify both edit contents and edit value. If both are specified, the one that occurs later in the script is used.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the TextEditbox.
indexnumber readonlyThe index of the TextEditbox within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
minWidthnumber r/wThe width of the control. For an editbox or combobox, specifies the minimum width of the box.
parentBorderPanelDialogColumn
DialogRow
EnablingGroup
readonlyThe parent of the TextEditbox (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
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)

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

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

TextEditbox TextEditboxes.nextItem (obj: TextEditbox)

TextEditbox TextEditboxes.previousItem (obj: TextEditbox)

Return

Array of TextEditbox TextEditbox.getElements ()

TextEditbox TextEditboxes.[] (index: number)

TextEditbox TextEditboxes.add ([withProperties: Object])

TextEditbox TextEditboxes.anyItem ()

Array of TextEditbox TextEditboxes.everyItem ()

TextEditbox TextEditboxes.firstItem ()

TextEditbox TextEditboxes.item (index: varies)

TextEditbox TextEditboxes.itemByID (id: number)

Array of TextEditbox TextEditboxes.itemByRange (from: varies, to: varies)

TextEditbox TextEditboxes.lastItem ()

TextEditbox TextEditboxes.middleItem ()

TextEditbox TextEditboxes.nextItem (obj: TextEditbox)

TextEditbox TextEditboxes.previousItem (obj: TextEditbox)

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