ssCore.Tray.setTooltip

Change the tooltip text that will appear when you mouse over the icon in the system tray.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

text - The new tooltip text. If the text has newlines ('\n') in it, a multiline tooltip will be displayed.


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.Tray.setTooltip( 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.Tray.setTooltip( paramsObject );


Notes:

None.


Examples:

ssCore.Tray.setTooltip({text:"This is the system tray toolip"});