Favorites Object

The Favorites object provides the current favorites settings and is also a collection of the favorites.

Members Table

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


    Properties Description
    AddingAllowed If adding favorites is allowed.
    ConfigFilename Full path to the favorites config file.
    Enabled If favorites are enabled.
    SaveOnClose If favorites should be saved when SiteKiosk is closed.
    Count The number of existing favorites.
    Methods Description
    Item Returns one item of the collection.

    This object is available through the main object SiteKiosk. Use the Favorites object to receive the favorites settings.

    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.
    The following example determines whether favorites are enabled and shows it in an alert window.

    <SCRIPT TYPE="text/javascript">

Applies to
    SiteKiosk v5.5 (and later versions).

Back to top