ScriptUIExtendScript only
Object

Checkbox

A dual-state control showing a box that has a checkmark when the value is true, and is empty when the value is false.

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.
Number 0– read/write A number of characters for which to reserve space when calculating the preferred size of the element.
Object[] readonly An array of child elements.
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.
String = left read/write The default text justification style for child text elements.
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 item (properties used only when the element is created).
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 read/write The text to display, a localizable string.
String readonly The element type; "checkbox".
Boolean read/write The selection state of the control.
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

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.

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 element has been clicked.

void

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

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.

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.