MenuSeparators
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
MenuSeparator add ([at:
LocationOptions=LocationOptions.AT_END][, reference:
MenuElement][, withProperties:
Object])
Creates a new menu separator.
| Parameter | Type | Description |
|---|---|---|
| at | LocationOptions: 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) |
| 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.
Array
of MenuSeparator everyItem ()
Returns every MenuSeparator in the collection.
MenuSeparator firstItem ()
Returns the first MenuSeparator in the collection.
MenuSeparator item (index:
any)
Returns the MenuSeparator with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer 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 itemByName (name:
string)
Returns the MenuSeparator with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of MenuSeparator itemByRange (from:
any, to:
any)
Returns the MenuSeparators within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer MenuSeparator String | The MenuSeparator, index, or name at the beginning of the range. Can accept: MenuSeparator, Long Integer or String. |
| to | Long 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.
| 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.
Element of
Menu.menuSeparators
Submenu.menuSeparators
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |