InDesign2026
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 21.5.1.73
Object

ScriptMenuAction

A script menu action.

MenuAction ›ScriptMenuAction
Hierarchy

Application

ScriptMenuAction

Properties

NameType AccessDescription
String read/write The menu action area.
Boolean read/write If true, the menu item associated with the menu action is checked.
Boolean read/write If true, the ScriptMenuAction is enabled.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the ScriptMenuAction.
Number readonly The index of the ScriptMenuAction 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 read/write The name of the ScriptMenuAction.
Application readonly The parent of the ScriptMenuAction (a Application).
Object read/write A property that allows setting of several properties at the same time.
String read/write The name of the ScriptMenuAction 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 ScriptMenuAction is invoked. This event does not bubble. This event is not cancelable.
Dispatched before the ScriptMenuAction is displayed. This event does not bubble. This event is not cancelable.
Dispatched before the ScriptMenuAction is invoked. This event does not bubble. This event is cancelable.
Dispatched when the ScriptMenuAction is invoked. This event does not bubble. This event is not 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.
→ ScriptMenuAction[]

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.

→ void

Deletes the ScriptMenuAction.

→ 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 ScriptMenuAction.

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a ScriptMenuAction.

Event.parentEventListener.parentMutationEvent.parent

Parameter of 3

Method parameters that accept a ScriptMenuAction.

ScriptMenuActions.itemByRange(from)ScriptMenuActions.nextItem(obj)ScriptMenuActions.previousItem(obj)

Return 14

Methods that return a ScriptMenuAction.

ScriptMenuAction.getElements()ScriptMenuActions.[]()ScriptMenuActions.add()ScriptMenuActions.anyItem()ScriptMenuActions.everyItem()ScriptMenuActions.firstItem()ScriptMenuActions.item()ScriptMenuActions.itemByID()ScriptMenuActions.itemByName()ScriptMenuActions.itemByRange()ScriptMenuActions.lastItem()ScriptMenuActions.middleItem()ScriptMenuActions.nextItem()ScriptMenuActions.previousItem()