Tooltip Mode Options

All single point value Canvas controls support configurable tooltips. There are three options for the contents of the tooltip:

  1. plain and/or tokenized text that resolve to point and facility attributes
  2. a small object file, which can receive its facility tag from the control showing the tooltip
  3. a script option that fires a TooltipOpening event right before the tooltip opens creating a custom tooltip, which can show any desired information, for example, a value from an affiliated point, an unrelated data point, or even a CygNet note.

The type of tooltip is determined by the Tooltip mode property in the Property pane:

To configure a text tooltip

Text tooltip

A Text tooltip with a value for the facility

Perform the following steps to configure a text tooltip:

  1. Find the Tooltip properties in the Properties pane. Configure the following properties:
    1. Tooltip enabled — Click to enable the tooltip.
    2. Tooltip mode — Select Text from the drop-down menu.
    3. Tooltip — Click Open dialog box to configure text and property strings using the CygNet Property String dialog box. Select text and token to be displayed in the tooltip.
To configure an object tooltip

Object tooltip

An Object tooltip showing an object file
containing two donuts with related points.
The facility has been passed in from the text tool.

Perform the following steps to configure an object tooltip:

  1. Find the Tooltip properties in the Properties pane. Configure the following properties:
    1. Make an object file (.cob) to display in the tooltip. The facility can be passed in from the control displaying the tooltip.
    2. Tooltip enabled — Click to enable the tooltip.
    3. Tooltip mode — Select Object from the drop-down menu.
    4. Tooltip object path — Click Open dialog box to open the Open dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder. Select the Object file (.cob) that you want to display in the tooltip.
To configure a script tooltip

Script tooltip

A Script tooltip showing a related value for the facility

Perform the following steps to configure an object tooltip:

  1. Find the Tooltip properties in the Properties pane. Configure the following properties:
    1. Tooltip enabled — Click to enable the tooltip.
    2. Tooltip mode — Select Script from the drop-down menu.
    3. Add script to the screen for the the TooltipOpening event to determine the content of the scripted tooltip.