Adobe InCopy CS6 (8.0) Object Model JS: Submenu

InCopy CS6

Class

Submenu

 A submenu. Base Class: MenuElement

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Menu | Submenu
MenuElement
Submenu
Event | EventListener | MenuElement | MenuItem | MenuSeparator | MutationEvent | Submenu

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
indexnumber readonlyThe index of the Submenu within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
menuElementsMenuElements MenuElement readonlyA collection of menu elements.
menuItemsMenuItems MenuItem readonlyA collection of menu items.
menuSeparatorsMenuSeparators MenuSeparator readonlyA collection of menu separators.
namestring readonlyThe name of the Submenu.
parentMenuSubmenu readonlyThe parent of the Submenu (a Menu or Submenu).
propertiesObject r/wA property that allows setting of several properties at the same time.
submenusSubmenus Submenu readonlyA collection of submenus.
titlestring readonlyThe name of the Submenu 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.

Class

PropertyTypeAccessDescription
BEFORE_DISPLAYstring readonlyDispatched before the Submenu is displayed. This event does not bubble. This event is not cancelable. (default: beforeDisplay)

Methods

Instances

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

void remove ()
Deletes the Submenu.

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

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

MenuElement.parent

MenuItem.parent

MenuSeparator.parent

Submenu.parent

Used in:

Submenu Submenus.nextItem (obj: Submenu)

Submenu Submenus.previousItem (obj: Submenu)

Return

Array of Submenu Submenu.getElements ()

Submenu Submenus.[] (index: number)

Submenu Submenus.add (title: string[, at: LocationOptions=LocationOptions.AT_END][, reference: MenuElement][, withProperties: Object])

Submenu Submenus.anyItem ()

Array of Submenu Submenus.everyItem ()

Submenu Submenus.firstItem ()

Submenu Submenus.item (index: varies)

Submenu Submenus.itemByName (name: string)

Array of Submenu Submenus.itemByRange (from: varies, to: varies)

Submenu Submenus.lastItem ()

Submenu Submenus.middleItem ()

Submenu Submenus.nextItem (obj: Submenu)

Submenu Submenus.previousItem (obj: Submenu)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index