Adobe InCopy CS5 (7.0) Object Model JS: MenuSeparator

InCopy CS5

Class

MenuSeparator

 A menu separator. Base Class: MenuElement

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Menu | Submenu
MenuElement
MenuSeparator
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the MenuSeparator.
indexnumber readonlyThe index of the MenuSeparator within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentMenuSubmenu readonlyThe parent of the MenuSeparator (a Menu or Submenu).
propertiesObject r/wA property that allows setting of several properties at the same time.

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 MenuSeparator getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the MenuSeparator.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

MenuSeparator MenuSeparators.nextItem (obj: MenuSeparator)

MenuSeparator MenuSeparators.previousItem (obj: MenuSeparator)

Return

Array of MenuSeparator MenuSeparator.getElements ()

MenuSeparator MenuSeparators.[] (index: number)

MenuSeparator MenuSeparators.add ([at: LocationOptions=LocationOptions.AT_END][, reference: MenuElement][, withProperties: Object])

MenuSeparator MenuSeparators.anyItem ()

Array of MenuSeparator MenuSeparators.everyItem ()

MenuSeparator MenuSeparators.firstItem ()

MenuSeparator MenuSeparators.item (index: varies)

MenuSeparator MenuSeparators.itemByID (id: number)

Array of MenuSeparator MenuSeparators.itemByRange (from: varies, to: varies)

MenuSeparator MenuSeparators.lastItem ()

MenuSeparator MenuSeparators.middleItem ()

MenuSeparator MenuSeparators.nextItem (obj: MenuSeparator)

MenuSeparator MenuSeparators.previousItem (obj: MenuSeparator)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index