ToolTip Object

The ToolTip object represents a new tooltip.

Members Table

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

    Properties Description
    BackgroundColor Background color.
    Balloon If the tooltip appears as a balloon or as a rectangle.
    CloseButton If a close button is shown.
    Icon Icon to display inside the tooltip.
    MaxWidth Maximum width.
    NoAnimate If the tooltip doesn't slide when it is hidden or shown.
    NoFade If the tooltip doesn't fade when it it hidden or shown.
    NoPrefix If prefix is disabled.
    Text Content of the tooltip.
    TextColor Color of the text and the border.
    Title Title displayed inside the tooltip.
    Methods Description
    Hide Hides the tooltip.
    SetMargin Sets the margin between border and text.
    SetPosition Sets the position of the tooltip.
    Show Shows the tooltip.

    This object is returned by the SiteKioskUI.CreateToolTip or UserInterface.CreateToolTip method. Use the ToolTip object to modify, show or hide the new tooltip.

    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 shows a tooltip when the mouse enters the text.

    <span id='mydiv' onMouseEnter='OnMouseEnter()'
    onMouseLeave='OnMouseLeave()' onMouseMove='OnMouseMove()'>
    Move the mouse over here.
    <SCRIPT TYPE="text/javascript">
    function OnMouseEnter()
       myToolTip = SiteKiosk.SiteKioskUI.CreateToolTip();
       myToolTip.Balloon = true;
       myToolTip.NoAnimate = false;
       myToolTip.NoFade = false;
       myToolTip.NoPrefix = false;
       myToolTip.MaxWidth = 150;
       myToolTip.Title = "Title";
       myToolTip.Text = "This is the content";
       myToolTip.Icon = 1;
       myToolTip.CloseButton = true;     // Windows XP only
       myToolTip.SetMargin(5, 5, 5, 5);
       myToolTip.SetPosition(event.screenX, event.screenY);
    function OnMouseMove()
       myToolTip.SetPosition(event.screenX, event.screenY);
    function OnMouseLeave()

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

Back to top