InDesign2026
API 21.5.1.73
Object

TextEditbox

A text entry field.

Widget TextEditbox
Hierarchy

BorderPanel | DialogColumn | DialogRow | EnablingGroup

TextEditbox

Properties

NameType AccessDescription
String read/write 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.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the TextEditbox.
Number readonly The index of the TextEditbox 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.
DialogRow | EnablingGroup | BorderPanel | DialogColumn readonly The parent of the TextEditbox (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
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.
TextEditbox[]

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

String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a TextEditbox.

Parameter of 3

Method parameters that accept a TextEditbox.

Return 13

Methods that return a TextEditbox.