InDesign2026
API 21.5.1.73
Object

ButtonPreference

Button preferences.

Preference ButtonPreference
Hierarchy

Application | Document

ButtonPreference

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write The name of the ButtonPreference.
Application | Document readonly The parent of the ButtonPreference (a Application or Document).
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.
ButtonPreference[]

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

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a ButtonPreference.

Return 1

Methods that return a ButtonPreference.