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

InCopy CS5.5

Class

PercentEditbox

 A percentage entry field. Base Class: Widget

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

BorderPanel | DialogColumn | DialogRow | EnablingGroup
Widget
PercentEditbox
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.
editValuenumber r/wThe 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.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the PercentEditbox.
indexnumber readonlyThe index of the PercentEditbox within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
largeNudgenumber r/wThe 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.
maximumValuenumber r/wThe 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.
minWidthnumber r/wThe width of the control. For an editbox or combobox, specifies the minimum width of the box.
minimumValuenumber r/wThe 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.
parentBorderPanelDialogColumn
DialogRow
EnablingGroup
readonlyThe parent of the PercentEditbox (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
propertiesObject r/wA property that allows setting of several properties at the same time.
smallNudgenumber r/wThe 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.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

PercentEditbox PercentEditboxes.nextItem (obj: PercentEditbox)

PercentEditbox PercentEditboxes.previousItem (obj: PercentEditbox)

Return

Array of PercentEditbox PercentEditbox.getElements ()

PercentEditbox PercentEditboxes.[] (index: number)

PercentEditbox PercentEditboxes.add ([withProperties: Object])

PercentEditbox PercentEditboxes.anyItem ()

Array of PercentEditbox PercentEditboxes.everyItem ()

PercentEditbox PercentEditboxes.firstItem ()

PercentEditbox PercentEditboxes.item (index: varies)

PercentEditbox PercentEditboxes.itemByID (id: number)

Array of PercentEditbox PercentEditboxes.itemByRange (from: varies, to: varies)

PercentEditbox PercentEditboxes.lastItem ()

PercentEditbox PercentEditboxes.middleItem ()

PercentEditbox PercentEditboxes.nextItem (obj: PercentEditbox)

PercentEditbox PercentEditboxes.previousItem (obj: PercentEditbox)

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