InDesign2026
API 21.5.1.73
Object

CheckboxControl

A checkbox control.

Widget CheckboxControl
Hierarchy

BorderPanel | DialogColumn | DialogRow | EnablingGroup

CheckboxControl

Properties

NameType AccessDescription
Boolean read/write If true, the control is checked by default in the dialog.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the CheckboxControl.
Number readonly The index of the CheckboxControl 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 CheckboxControl (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
Object read/write A property that allows setting of several properties at the same time.
String read/write Text that appears in the CheckboxControl.

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.
CheckboxControl[]

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

String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a CheckboxControl.

Parameter of 3

Method parameters that accept a CheckboxControl.

Return 13

Methods that return a CheckboxControl.