InDesign2026
API 21.5.1.73
Object

MenuAction

A menu action.

Extended byScriptMenuAction
Hierarchy

Application

MenuAction

Properties

NameType AccessDescription
String readonly The menu action area.
Boolean readonly If true, the menu item associated with the menu action is checked.
Boolean readonly If true, the MenuAction is enabled.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the MenuAction.
Number readonly The index of the MenuAction within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String readonly The name of the MenuAction.
Application readonly The parent of the MenuAction (a Application).
Object read/write A property that allows setting of several properties at the same time.
String readonly The name of the MenuAction for display in the user interface. The title includes any ampersand characters (&), which are used to tell the Windows OS to underline the following character in the name for use with the Alt key to navigate to a menu item. Double ampersands are used to display an actual ampersand character in the name. The Mac OS ignores and removes the extra ampersand characters.

Events

NameDescription
Dispatched after the MenuAction is invoked. This event does not bubble. This event is not cancelable.
Dispatched before the MenuAction is invoked. This event does not bubble. This event is cancelable.

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

Gets the label value associated with the specified key.

key String The key.
MenuAction[]

Resolves the object specifier, creating an array of object references.

void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
void

Invoke the action.

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a MenuAction.

Parameter of 4

Method parameters that accept a MenuAction.

Return 13

Methods that return a MenuAction.