Adobe InDesign CS6 (8.0) Object Model JS: ScriptMenuActions

InDesign CS6

Class

ScriptMenuActions

 A collection of script menu actions.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

ScriptMenuAction [] (index: number)
Returns the ScriptMenuAction with the specified index.

ParameterTypeDescription
indexnumberThe index.

ScriptMenuAction add ([title: string][, withProperties: Object])
Creates a new action.

ParameterTypeDescription
titlestringThe 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. (Optional)
withPropertiesObjectInitial values for properties of the new ScriptMenuAction (Optional)

ScriptMenuAction anyItem ()
Returns any ScriptMenuAction in the collection.

number count ()
Displays the number of elements in the ScriptMenuAction.

Array of ScriptMenuAction everyItem ()
Returns every ScriptMenuAction in the collection.

ScriptMenuAction firstItem ()
Returns the first ScriptMenuAction in the collection.

ScriptMenuAction item (index: varies)
Returns the ScriptMenuAction with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

ScriptMenuAction itemByID (id: number)
Returns the ScriptMenuAction with the specified ID.

ParameterTypeDescription
idnumberThe ID.

ScriptMenuAction itemByName (name: string)
Returns the ScriptMenuAction with the specified name.

ParameterTypeDescription
namestringThe name.

Array of ScriptMenuAction itemByRange (from: varies, to: varies)
Returns the ScriptMenuActions within the specified range.

ParameterTypeDescription
fromLong Integer
ScriptMenuAction
String
The ScriptMenuAction, index, or name at the beginning of the range. Can accept: ScriptMenuAction, Long Integer or String.
toLong Integer
ScriptMenuAction
String
The ScriptMenuAction, index, or name at the end of the range. Can accept: ScriptMenuAction, Long Integer or String.

ScriptMenuAction lastItem ()
Returns the last ScriptMenuAction in the collection.

ScriptMenuAction middleItem ()
Returns the middle ScriptMenuAction in the collection.

ScriptMenuAction nextItem (obj: ScriptMenuAction)
Returns the ScriptMenuAction whose index follows the specified ScriptMenuAction in the collection.

ParameterTypeDescription
objScriptMenuActionThe ScriptMenuAction whose index comes before the desired ScriptMenuAction.

ScriptMenuAction previousItem (obj: ScriptMenuAction)
Returns the ScriptMenuAction with the index previous to the specified index.

ParameterTypeDescription
objScriptMenuActionThe index of the ScriptMenuAction that follows the desired ScriptMenuAction.

string toSource ()
Generates a string which, if executed, will return the ScriptMenuAction.

Element of

Application.scriptMenuActions

Jongware, 28-Apr-2012 v3.0.3hContents :: Index