This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %ZEN.Component.timer


class %ZEN.Component.timer extends %ZEN.Component.component

Client-side timer object. This component automatically creates a javascript timer object within the client and initializes it when the page is first loaded. The timer is one-shot; after it fires its ontimeout event, you must restart it by calling the client startTimer() method.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter DEFAULTVISIBLE = 0;
this component is not visible.

Properties (Including Private)

property ontimeout as %ZEN.Datatype.eventHandler;
ontimeout event handler: Client code to run when timeout expires.
Property methods: ontimeoutDisplayToLogical(), ontimeoutGet(), ontimeoutIsValid(), ontimeoutLogicalToDisplay(), ontimeoutLogicalToOdbc(), ontimeoutNormalize(), ontimeoutSet()
property timeout as %ZEN.Datatype.integer (MINVAL = 0);
Timeout value (in milliseconds).
Setting this to 0 will disable the timer.
Property methods: timeoutDisplayToLogical(), timeoutGet(), timeoutIsValid(), timeoutLogicalToDisplay(), timeoutLogicalToOdbc(), timeoutNormalize(), timeoutSet()

Methods (Including Private)

clientmethod clearTimer() [ Language = javascript ]
Clear the timer object used by this component.
clientmethod onDelete() [ Language = javascript ]
This client method, if present, is called when this component is removed from the page.
clientmethod onloadHandler() [ Language = javascript ]
This client event is fired when the page is loaded.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod startTimer() [ Language = javascript ]
Start the timer.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window