Events

A collection of events.

Methods:

anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Event anyItem ()

Returns any Event in the collection.

Number count ()

Displays the number of elements in the Event.

Event everyItem ()

Returns every Event in the collection.

Event firstItem ()

Returns the first Event in the collection.

Event item (index:Varies LongInteger String)

Returns the Event with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

Event itemByID (id:Number)

Returns the Event with the specified ID.

Parameter

Type

Description

id

Number

The ID.

Event itemByName (name:String)

Returns the Event with the specified name.

Parameter

Type

Description

name

String

The name.

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

Returns the Events within the specified range.

Parameter

Type

Description

from

Event

LongInteger

String

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

to

Event

LongInteger

String

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

Event lastItem ()

Returns the last Event in the collection.

Event middleItem ()

Returns the middle Event in the collection.

Event nextItem (obj:Event)

Returns the Event whose index follows the specified Event in the collection.

Parameter

Type

Description

obj

Event

The Event whose index comes before the desired Event.

Event previousItem (obj:Event)

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

Parameter

Type

Description

obj

Event

The index of the Event that follows the desired Event.

String toSource ()

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

Object of

Application.events

Document.events

MenuAction.events

ScriptMenuAction.events

Menu.events

Submenu.events