Timer

Timers, while not widgets strictly speaking, are defined in the same way as widgets. They allow you to define a recurring timed event. Timers may be associated with pages or the system object - the difference being that timers associated with pages are only available when that page is visible.

Properties

Timers have the following attributes/properties:

PropertyDescriptionRequiredIn templateDefaultScript
nameThe name of the timerNo_timernnRead-only 
intervalNumber of milliseconds between each eventYesN/AYes 
enabledControls whether the timer is running or notNofalseYes 

Methods

The following methods are supported by timers:

MethodDescription
start()Start the timer
stop()Stop the timer

Events

The following events are triggered by timers:

EventDescription
OnTimerOccurs each time the specified interval has elapsed (when the timer is enabled/started).