InDesign2026
API 21.5.1.73
Object

Widget

Generic term for an object in a dialog column or dialog row, including dialog controls such as radio button groups, checkboxes, editboxes, dropdowns, and comboboxes; static text objects; enabling groups; border panels; and nested dialog columns and dialog rows. For information, see dialog column, dialog row, static text, border panel, enabling group, radiobutton group, checkbox control, angle editbox, angle combobox, integer editbox, integer combobox, measurement editbox, measurement combobox, percent editbox, percent combobox, real editbox, real combobox, and text editbox.

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the Widget.
Number readonly The index of the Widget within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Number read/write The width of the control. For an editbox or combobox, specifies the minimum width of the box.
BorderPanel | DialogRow | EnablingGroup | DialogColumn | RadiobuttonGroup readonly The parent of the Widget (a DialogColumn, DialogRow, EnablingGroup, BorderPanel or RadiobuttonGroup).
Object read/write A property that allows setting of several properties at the same time.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
Widget[]

Resolves the object specifier, creating an array of object references.

Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

Generates a string which, if executed, will return the Widget.

String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a Widget.

Parameter of 3

Method parameters that accept a Widget.

Return 12

Methods that return a Widget.