ssCore.Tooltip.show

Displays a tooltip.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

text - Text to be displayed in the tooltip, may contain newline and tab characters.

delay - [Optional] - The startup delay in milliseconds before the tooltip is displayed. If this value is not supplied, the default system delay (normally 500ms) will be used.

timeout - [Optional] - The time in milliseconds before tooltip is automatically closed after being displayed. If no value is supplied, the default system delay (10 times the startup delay, or 5sec) will be used.

maxWidth - [Optional] - Maximum width (in pixels) of tooltip window.

maxHeight - [Optional] - Maximum height (in pixels) of tooltip window (will be rounded to show only complete lines).

fontName - [Optional] - Name of font to use in tooltip (windows system font name).

fontSize - [Optional] - Size of font to use in tooltip (must be allowable size for selected/default font).

tipColor - [Optional] - Color of tooltip window (in #rrggbb format). If not specified the system default color will be used.

textColor - [Optional] - Color of tooltip text (in #rrggbb format). If not specified the system default color will be used.

bevelColor - [Optional] - Color of tooltip top and left edges (in #rrggbb format). If not specified the default color (#404040) will be used.

edgeColor - [Optional] - Color of tooltip bottom and right edges (in #rrggbb format). If not specified the default color (#404040) will be used.

edge - [Optional] - Width of the edge in pixels, if not specified, a two pixel edge around the tooltip text will be used.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Tooltip.show( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Tooltip.show( paramsObject );


Notes:

None.


Examples:

ssCore.Tooltip.show({text:"This is a toolip", timeout:10000});