Adobe InCopy CS5.5 (7.5) Object Model JS: MenuSeparators

InCopy CS5.5

Class

MenuSeparators

 A collection of menu separators.

See also MenuSeparator.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

MenuSeparator add ([at: LocationOptions=LocationOptions.AT_END][, reference: MenuElement][, withProperties: Object])
Creates a new menu separator.

ParameterTypeDescription
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location of the menu separator relative to the reference object or within the containing object. (Optional) (default: LocationOptions.AT_END)
referenceMenuElementThe reference object. Note: Required when the at parameter specifies before or after. (Optional)
withPropertiesObjectInitial values for properties of the new MenuSeparator (Optional)

MenuSeparator anyItem ()
Returns any MenuSeparator in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

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

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

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

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

ParameterTypeDescription
objMenuSeparatorThe MenuSeparator whose index comes before the desired MenuSeparator.

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

ParameterTypeDescription
objMenuSeparatorThe index of the MenuSeparator that follows the desired MenuSeparator.

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

Element of

Menu.menuSeparators

Submenu.menuSeparators

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