Tool Tips

setDeveloperToolTip(); Set Developer Tooltip
setDeveloperToolTipDefault(); Set Developer Tooltip Default
setDynamicToolTip(); Set Dynamic Tooltip
setToolTipBackdropColor();
setToolTipBackdropSize(); Set Tooltip Backdrop Size
setToolTipBackgroundColor(); Set Tooltip Background Color
setToolTipColor(); Set Tooltip Color
setToolTipFontName(); Set Tooltip Font Name
setToolTipFontSize(); Set Tooltip Font Size
setToolTipFontStyle(); Set Tooltip Style
setToolTipOff(); Enable Tooltips
setToolTipOn(); Disable Tooltips
setUserToolTip(); Set User Tooltip
setUserToolTipDefault(); Set User Tooltip Default

setDeveloperToolTip()

When the ToolTipDisplay property is enabled (true) and the ToolTipMode property selects developer information mode (1), the setDeveloperToolTip() method can be used to define a custom tool tip string that will be displayed when the user positions the mouse pointer over a selectable object in a chart.

When ToolTipMode selects developer information, the default tool tip string consists of the following: Object ID, object description, series number (if applicable), group number (if applicable), and value (if applicable).

SYNTAX:

void setDeveloperToolTip (String CustomToolTip);

INPUT:

CustomToolTip; Any string of characters which may or may not include the following macros:
[ON] = Object Name
[OID] = Object ID
[R] = New Line
[OIN] = Object Instance
[OD] = Object Description
[SL] = Series Label 
[GL] = Group Label

RETURN:

void

EXAMPLE:

setToolTipDisplay (true);
setToolTipMode (true);
setDeveloperToolTip ( "This is the developer's tool tip");

ALSO SEE:

ToolTipDisplay, ToolTipMode, setDeveloperToolTipDefault(), setUserToolTip()

setDeveloperToolTipDefault()

The setDeveloperToolTipDefault() method selects the default developer tool tip strings that are provided with the application. When ToolTipMode selects developer information, the default tool tip string consists of the following: Object ID, object description, series number (if applicable), group number (if applicable), and value (if applicable).

SYNTAX:

void setDeveloperToolTipDefault();

INPUT:

None

RETURN:

void

EXAMPLE:

setDeveloperToolTipDefault();
setToolTipMode (true);
setToolTipDisplay (true);

ALSO SEE:

ToolTipDisplay, ToolTipMode, setDeveloperToolTip(), setUserToolTip()

setDynamicToolTip()

This method can be used to set the dynamic tool tip to any specific string. If NULL or "" is used, a tool tip will not be generated. Multiple lines may be used in the string definition. See the macros defined below.

SYNTAX:

void setDynamicToolTip (String aTooptip);

INPUT:

aToolTip; A string of characters which may or may not include the following macros:
[ON] = Object Name
[OID] = Object ID
[R] = New Line
[OIN] = Object Instance
[OD] = Object Description
[SL] = Series Label 
[GL] = Group Label
Use NULL or "" to disable the generation of an event for tool tips. If you use setDynamicToolTip (null) or setDynamicToolTip ("") and the callback also returns null or "", tool tips will not be generated.

RETURN:

void

setToolTipBackdropColor()

When tooltips are enabled with setToolTipDisplay (true), this method can be used to assign a backdrop (shadow) color to the tooltip.

SYNTAX:

void setToolTipBackdropColor (Color colorBackdrop);

INPUT:

colorBackdrop; tooltip backdrop color

RETURN:

void;

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackdropColor (new Color (255, 0, 0));

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackdropColor (new Color (0, 255, 0));

ALSO SEE:

ToolTipDisplay(), setToolTipBackdropSize()

setToolTipBackdropSize()

When tooltips are enabled with setToolTipDisplay (true), this method can be used to define the size of a backdrop (shadow).

SYNTAX:

void setToolTipBackdropSize (int nBackdropSize);

INPUT:

nBackdropSize; tooltip backdrop size

RETURN:

void;

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackdropColor (new Color (255, 0, 0));
setToolTipBackdropSize (10);

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackdropColor (new Color (255, 0, 0));
setToolTipBackdropSize (20);

ALSO SEE:

setToolTipBackdropColor(), ToolTipDisplay()

setToolTipBackgroundColor()

This method can be used to define the color of background behind tooltip text.

SYNTAX:

void setToolTipBackgroundColor (Color colorBackground);

INPUT:

colorBackground; tooltip background color

RETURN:

void;

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackgroundColor (new Color (0, 255, 0));
setToolTipBackdropColor (new Color (255, 0, 0));
setToolTipBackdropSize (10);

ALSO SEE:

setToolTipBackdropColor(), setToolTipBackdropSize(), setToolTipColor(),

setToolTipColor()

This method can be used to define the color of tooltip text.

SYNTAX:

void setToolTipColor (Color colorToolTip);

INPUT:

colorToolTip; tooltip color

RETURN:

void;

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackgroundColor (new Color (0, 255, 0));
setToolTipBackdropColor (new Color (0, 0, 255));
setToolTipColor (new Color (255, 0, 0));
setToolTipBackdropSize (10);

ALSO SEE:

setToolTipBackdropColor(), setToolTipBackdropSize(), setToolTipBackgroundColor(), setToolTipFontName(), setToolTipFontSize(), setToolTipFontStyle()

setToolTipFontName()

This method assigns the font type value for a tooltip.

SYNTAX:

void setToolTipFontName (String strFontName);

INPUT:

strFontName; name of font string (i.e. arial, courier new, times new roman)

RETURN:

void;

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackgroundColor (new Color (0, 255, 0));
setToolTipBackdropColor (new Color (0, 0, 255));
setToolTipColor (new Color (255, 0, 0));
setToolTipBackdropSize (10);
setToolTipFontName ("Courier New");

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackgroundColor (new Color (0, 255, 0));
setToolTipBackdropColor (new Color (0, 0, 255));
setToolTipColor (new Color (255, 0, 0));
setToolTipBackdropSize (10);
setToolTipFontName ("Times New Roman");

ALSO SEE:

setToolTipColor(), setToolTipFontSize(), setToolTipFontStyle()

setToolTipFontSize()

This method assigns a font size (in points) to tooltip strings.

SYNTAX:

void setToolTipFontSize (int nFontSize);

INPUT:

nFontSize; font size in points

RETURN:

void;

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackgroundColor (new Color (0, 255, 0));
setToolTipBackdropColor (new Color (0, 0, 255));
setToolTipColor (new Color (255, 0, 0));
setToolTipBackdropSize (10);
setToolTipFontName ("Times New Roman");
setToolTipFontSize (18);
setToolTipDelay (1);

ALSO SEE:

setToolTipColor(), setToolTipFontName(), setToolTipFontStyle()

setToolTipFontStyle()

This method assigns a font style to tooltip strings (i.e bold, italic, underline).

SYNTAX:

void setToolTipFontStyle (int nFontStyle);

INPUT:

nFontStyle; 0...7. 0 = Plain, 1 = Italic, 2 = Bold, 3 = Italic/Bold, 4 = Underline, 5 = Italic/Underline, 6 = Bold/Underline, 7 = Bold/Italic/Underline

RETURN:

void;

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setToolTipDisplay (true);
setToolTipBackgroundColor (new Color (0, 255, 0));
setToolTipBackdropColor (new Color (0, 0, 255));
setToolTipColor (new Color (255, 0, 0));
setToolTipBackdropSize (10);
setToolTipFontName ("Times New Roman");
setToolTipFontSize (18);
setToolTipFontStyle (2);
setToolTipDelay (1);

ALSO SEE:

setToolTipColor(), setToolTipFontName(), setToolTipFontSize()

setToolTipOff()

This method turns off the generation of events for tool tips until a triggering event such as dwelling over some other object generates a new tooltip event.

SYNTAX:

void setToolTipOff();

INPUT:

None

RETURN:

void

ALSO SEE:

setDynamicToolTip()

setToolTipOn()

This method turns on the generation of events for tool tips.

SYNTAX:

void setToolTipOn();

INPUT:

None

RETURN:

void

ALSO SEE:

setToolTipOff()

setUserToolTip()

When the ToolTipDisplay property is enabled (true) and the ToolTipMode property selects user information mode (0), the setUserToolTip() method can be used to define a custom tool tip string that will be displayed when the user positions the mouse pointer over a selectable object in a chart.

SYNTAX:

void setUserToolTip (String CustomToolTip);

INPUT:

CustomToolTip; Any string of characters which may or may not include the following macros:
[ON] = Object Name
[OID] = Object ID
[R] = New Line
[OIN] = Object Instance
[OD] = Object Description
[SL] = Series Label 
[GL] = Group Label
Example: [ON] is ([OID]) [R] Instance # [OIN]

RETURN:

void

RETURN:

ToolTipDisplay, ToolTipMode, setDeveloperToolTip(), setUserToolTipDefault()

setUserToolTipDefault()

The setUserToolTipDefault() method selects the default developer tool tip strings that are provided with the application. When ToolTipMode selects developer information, the default tool tip string consists of the following: series, group, and value. Example:
Series: 3
Group: 4
Value: 60.0

SYNTAX:

void setUserToolTipDefault();

INPUT:

None

RETURN:

void

ALSO SEE:

ToolTipDisplay, ToolTipMode, setDeveloperToolTip(), setUserToolTip()