MenuAction

A menu action.

Methods:

addEventListener, extractLabel, getElements, insertLabel, invoke, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, String

Hierarchy:

Class: MenuAction

Subclasses: ScriptMenuAction

Property Listing

Property

Type

Access

Description

area

String

readonly

The menu action area.

checked

Boolean

readonly

If true, the menu item associated with the menu action is checked.

enabled

Boolean

readonly

If true, the MenuAction is enabled.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the MenuAction.

index

Number

readonly

The index of the MenuAction within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

readonly

The name of the MenuAction.

parent

Application

readonly

The parent of the MenuAction (a Application).

properties

Object

read/write

A property that allows setting of several properties at the same time.

title

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.

Constants/Events

Name

Type

Access

Description

AFTER_INVOKE

String

readonly

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

BEFORE_INVOKE

String

readonly

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

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

MenuAction getElements ()

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

undefined insertLabel (key:String, value:String)

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

Parameter

Type

Description

key

String

The key.

value

String

The value.

undefined invoke ()

Invoke the action.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the MenuAction.

String toSpecifier ()

Retrieves the object specifier.

Object of

MenuItem.associatedMenuAction

Event.parent

EventListener.parent

MutationEvent.parent

Return

MenuAction.getElements()

MenuActions.anyItem()

MenuActions.everyItem()

MenuActions.nextItem()

MenuActions.previousItem()

MenuActions.itemByID()

MenuActions.item()

MenuActions.[]()

MenuActions.itemByName()

MenuActions.itemByRange()

MenuActions.firstItem()

MenuActions.lastItem()

MenuActions.middleItem()