MenuSeparators

A collection of menu separators.

Go to Property Listing | Method Listing

Methods:

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

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

MenuSeparator [] (index:Number)

Returns the MenuSeparator with the specified index.

Parameter	Type	Description
index	Number	The index.

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

Creates a new menu separator.

Parameter	Type	Description
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location of the menu separator relative to the reference object or within the containing object. (Optional) (default: LocationOptions.AT_END)
reference	MenuElement	The reference object. Note: Required when the at parameter specifies before or after. (Optional)
withProperties	Object	Initial values for properties of the new MenuSeparator (Optional)

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location of the menu separator relative to the reference object or within the containing object. (Optional)

(default: LocationOptions.AT_END)

reference

MenuElement

The reference object. Note: Required when the at parameter specifies before or after. (Optional)

withProperties

Object

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

MenuSeparator everyItem ()

Returns every MenuSeparator in the collection.

MenuSeparator firstItem ()

Returns the first MenuSeparator in the collection.

MenuSeparator item (index:Varies LongInteger String)

Returns the MenuSeparator with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

MenuSeparator itemByID (id:Number)

Returns the MenuSeparator with the specified ID.

Parameter	Type	Description
id	Number	The ID.

MenuSeparator itemByRange (from:Varies LongInteger MenuSeparator String, to:Varies LongInteger MenuSeparator String)

Returns the MenuSeparators within the specified range.

Parameter	Type	Description
from	LongInteger MenuSeparator String	The MenuSeparator, index, or name at the beginning of the range. Can accept: MenuSeparator, Long Integer or String.
to	LongInteger MenuSeparator String	The MenuSeparator, index, or name at the end of the range. Can accept: MenuSeparator, Long Integer or String.

Parameter

Type

Description

from

LongInteger

MenuSeparator

String

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

LongInteger

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.

Parameter	Type	Description
obj	MenuSeparator	The MenuSeparator whose index comes before the desired MenuSeparator.

MenuSeparator previousItem (obj:MenuSeparator)

Returns the MenuSeparator with the index previous to the specified index.

Parameter	Type	Description
obj	MenuSeparator	The index of the MenuSeparator that follows the desired MenuSeparator.

String toSource ()

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

Object of

Menu.menuSeparators

Submenu.menuSeparators