ScriptUIExtendScript only
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
Object

ListBox

Displays a list of choices, represented by ListItem objects.

Properties

NameType AccessDescription
Boolean read/write True if this element is active.
String read/write The alignment style for this element. If defined, this value overrides the alignChildren setting for the parent container.
Bounds read/write The boundaries of the element, in parent-relative coordinates.
Object[] readonly An array of child ListItem elements.
Object readonly For a multi-column list box, the column properties.
Boolean read/write True if this element is enabled.
ScriptUIGraphics readonly The graphics object that can be used to customize the element's appearance, in response to the onDraw() event.
String read/write The help text that is displayed when the mouse hovers over the element.
Number 0– read/write The number of pixels to indent the element during automatic layout.
Dimension read/write The width and height in pixels of each item in the list.
ListItem[] readonly The array of choice items displayed in the list.
Point read/write The upper left corner of this element relative to its parent.
Dimension read/write The maximum height and width to which the element can be resized.
Dimension read/write The minimum height and width to which the element can be resized.
— readonly The parent element.
Dimension read/write The preferred size, used by layout managers to determine the best size for each element.
Object read/write An object that contains one or more creation properties of the control (properties used only when the element is created).
ListItem read/write The currently selected item for a single-selection list, or an array of items for current selection in a multi-selection list.
String read/write The key sequence that invokes the onShortcutKey() callback for this element (in Windows only).
Dimension read/write The current dimensions of this element.
String readonly The element type; "listbox".
Boolean read/write True if this element is shown, false if it is hidden.
Window readonly The window that this element belongs to.
Bounds readonly The bounds of this element relative to the top-level parent window.

Methods

→ ListItem

Adds an item to the choices in this list.

type String The type of the child element, the string "item".
text? String The localizable text label for the item.
→ Boolean

Registers an event handler for a particular type of event occuring in this element.

eventName String The name of the event.
handler Function The function that handles the event.
capturePhase Boolean When true, the handler is called only in the capturing phase of the event propagation.
→ Event

Simulates the occurrence of an event in this target.

→ ListItem

Retrieves an item object from the list that has a given text label.

text String The text string to match.
→ void

Hides this element.

→ void

Sends a notification message, simulating the specified user interaction event.

eventName? String The name of the control event handler to call.
→ void

An event-handler callback function, called when the element acquires the keyboard focus.

→ void

An event-handler callback function, called when the content of the element has been changed

→ void

An event-handler callback function, called when the element loses the keyboard focus.

→ void

An event-handler callback function, called when an item in the listbox is double-clicked

→ void

An event-handler callback function, called when the window is about to be drawn.

→ void

An event-handler callback function, called when the element's shortcutKey sequence is typed in the active window.

→ void

Removes a child item from the list.

what Varies The item or child to remove, specified by 0-based index, text value, or as a ListItem object.
→ void

Removes all child items from the list.

→ Boolean

Unregisters an event handler for a particular type of event occuring in this element.

eventName String The name of the event.
handler Function The function that handles the event.
capturePhase Boolean Whether to call the handler only in the capturing phase of the event propagation.
→ void

Shows this element.