Adobe InCopy CS5.5 (7.5) Object Model JS: RealEditbox

InCopy CS5.5

previous page next page

Class

RealEditbox

A high-precision numeric entry field. Base Class: Widget

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

BorderPanel | DialogColumn | DialogRow | EnablingGroup

Widget

RealEditbox

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
editContents	string	r/w	The 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.
editValue	number	r/w	The real number default value of the editbox or combobox. Note: For measurement controls, the value is interpreted in points. The points value is converted to edit units when the dialog opens. Note: Do not specify both edit value and edit contents. If both are specified, the one that occurs later in the script is used.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	number	readonly	The unique ID of the RealEditbox.
index	number	readonly	The index of the RealEditbox within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
largeNudge	number	r/w	The amount to increment/decrement the value when a user selects the control and holds down the Shift key while pressing an arrow key on the keyboard.
maximumValue	number	r/w	The maximum value that a user is allowed to type in a numeric editbox or combobox. Note: The value for a measurement editbox or combobox is interpreted in points, regardless of the edit units specified for the control. The points value is converted automatically to the edit unit when the dialog is opened.
minWidth	number	r/w	The width of the control. For an editbox or combobox, specifies the minimum width of the box.
minimumValue	number	r/w	The minumim value that a user is allowed to type in a numeric editbox or combobox. Note: The value for a measurement editbox or combobox is interpreted in points, regardless of the edit units specified for the control. The points value is converted automatically to the edit unit when the dialog is opened.
parent	BorderPanel DialogColumn DialogRow EnablingGroup	readonly	The parent of the RealEditbox (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
properties	Object	r/w	A property that allows setting of several properties at the same time.
smallNudge	number	r/w	The amount to increment/decrement the value when the user selects the control and presses an arrow key on the keyboard.

Methods

Instances

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

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

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)