Adobe InCopy CS5 (7.0) Object Model JS: ScriptMenuAction

previous page next page

Class

ScriptMenuAction

A script menu action. Base Class: MenuAction

ScriptMenuAction

Property	Type	Access	Description
area	string	r/w	The menu action area.
checked	bool	r/w	If true, the menu item associated with the menu action is checked.
enabled	bool	r/w	If true, the ScriptMenuAction is enabled.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
id	number	readonly	The unique ID of the ScriptMenuAction.
index	number	readonly	The index of the ScriptMenuAction within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the ScriptMenuAction.
parent	Application	readonly	The parent of the ScriptMenuAction (a Application).
properties	Object	r/w	A property that allows setting of several properties at the same time.
title	string	r/w	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.

Property	Type	Access	Description
AFTER_INVOKE	string	readonly	Dispatched after the ScriptMenuAction is invoked. This event does not bubble. This event is not cancelable. (default: afterInvoke)
BEFORE_DISPLAY	string	readonly	Dispatched before the ScriptMenuAction is displayed. This event does not bubble. This event is not cancelable. (default: beforeDisplay)
BEFORE_INVOKE	string	readonly	Dispatched before the ScriptMenuAction is invoked. This event does not bubble. This event is cancelable. (default: beforeInvoke)
ON_INVOKE	string	readonly	Dispatched when the ScriptMenuAction is invoked. This event does not bubble. This event is not cancelable. (default: onInvoke)

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	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.

Array of ScriptMenuAction getElements ()
Resolves the object specifier, creating an array of object references.

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

void invoke ()
Invoke the action.

void remove ()
Deletes the ScriptMenuAction.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)