ScreenSaver Object

---

The ScreenSaver object controls the screensaver.

Members Table

The following table lists the members provided by the ScreenSaver object.

Members

Properties	Description
Active	If the screensaver is active.
Enabled	If the screensaver is enabled.
IdleTime	Contains the idle time.
RunningTime	Current running time.
WaitTime	Contains the wait time.
Methods	Description
Activate	Starts the screensaver.
Reactivate	Reactivates SiteKiosk.
Events	Description
OnScreenSaverActivator	Fires when a sensor detects activity/inactivity.
OnScreenSaverBegin	Fires when the screensaver becomes active.
OnScreenSaverEnd	Fires when the screensaver becomes inactive.

Remarks

This object is available through the main object SiteKiosk. Use the ScreenSaver object to receive the screensaver settings or to reactivate it.

Note that the path of a file using SiteKiosk objects must be allowed in the
SiteKiosk configuration (Security -> Access -> URL's With Script Permission)
if it is not a browser skin file.

Examples

The following example shows in an alert window if the screensaver is active.

<SCRIPT TYPE="text/javascript"> window.external.InitScriptInterface(); alert(SiteKiosk.ScreenSaver.Active); </SCRIPT>

Applies to

SiteKiosk v5.0 (and later versions).

---

Back to top