SiteKiosk Main Objects and ActiveX Controls




SiteKiosk provides a number of objects and ActiveX controls to manipulate the SiteKiosk application by means of a script. This script is called the SiteKiosk Object Model. This documentation is for IE-based browsers of SiteKiosk Windows. Currently there is no detailed documenation available for the SiteKiosk Object Model for Chrome-based browsers in SiteKiosk Windows and SiteKiosk Android, please contact our support to receive a basic documentation.

SiteKiosk Main Objects and ActiveX Controls

    The following table lists the main objects and ActiveX controls provided by SiteKiosk.
    Click here to view a SiteKiosk Objects graphic.

    Main Objects and ActiveX Controls
    Objects Description
    AdminFunctions Object to control window management and to show log messages.
    SiteCafe Main object of the SiteCafe Manager object model.
    SiteKiosk Main object of the SiteKiosk Browser object model.
    SiteKioskConfig Main object of the SiteKiosk Configuration object model.
    SiteKioskWindow Represents a window of the SiteKiosk application.
    ActiveX Controls Description
    SiteCam Control to use a web cam.
    SiteKioskBrowserCtrl SiteKiosk browser control.
    SKAnimateControl Busy animation control.
    SKFileIcon Control to display file icons.
    SKPictureControl Control to display pictures.
    SKProgressBar Gradient progress bar control with blocking option.
    SKResize Resize control to resize SiteKiosk windows.
    StaticText Static text control including a fixed-single line and a text ellipsis.
    TrayIcon Control to display icons of the taskbar notification area.
    URLComboBox URL address ComboBox control.
    WindowIcon Control to display Windows icons in HTML pages.

Developers
    Developers should see this C# example for further information about how to access the ISiteKiosk Interface from other programming languages.
Remarks
    The SiteKiosk objects and ActiveX controls are available in the form scripts that can be used in combination with SiteKiosk. They make it possible to control certain SiteKiosk features and to individualize the SiteKiosk application.

    Before you can use the SiteKiosk objects in a script you need to call the function window.external.InitScriptInterface() to initialize the script interface.
    If you like to use the SiteKiosk Object Model within FRAMES then you have to use window.external.InitScriptInterface(document) instead of window.external.InitScriptInterface().

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

Back to top