toolTip

Form XML code:

<element_name toolTip="The text you need">

By default, the property is not specified and, thus, is absent from the form XML code. The property value will appear in the form XML code only once the property value is specified.

Theme property filter XML code:

<DoStyleAction>

  <SetProperty nil="yes">

    <PropertyPath>

      <PropertyName>ToolTip</PropertyName>

    </PropertyPath>

  </SetProperty>

</DoStyleAction>

Possible values: depend on the user's needs

Default value: not specified

Associated functions:

fgl_setactionlabel()

fgl_setkeylabel()

fgl_dialog_setactionlabel()

fgl_dialog_setkeylabel()

Associated containers, widgets and theme elements:

Associated ui methods:

SetToolTip ↓

GetToolTip ↓

Influence and behavior:

toolTip specifies the text of the tool tip which will become visible when the mouse hovers over the form element at runtime:

A form element will have no tooltips if the corresponding property has no value.

To remove the tooltip, you have just to clear its value (when set in Lycia Form Designer) or remove the property (when set in Lycia Theme Designer).

At runtime, you can use ui methods to find out the maximum length of the data string which can be input to the field and change it:

LET widget_var = ui.<widget>.ForName("widget_id")

CALL widget_var.setTooltip("tooltip_text")

DISPLAY widget_var.getTooltip()

At runtime, you can add tooltips to toolbar buttons by specifying the sixth parameter of the corresponding functions:

→   fgl_setactionlabel():

CALL fgl_setactionlabel("ActName","DisplayInfo", "cup", 1, TRUE, "Your tooltip text")

→   fgl_setkeylabel():

CALL fgl_setkeylabel("F1","F1 toolbarKey", "images/css-24.png", 3, TRUE, "Your tooltip text")

→   fgl_dialog_setactionlabel():

CALL fgl_dialog_setactionlabel("ActName","LABEL_1", "cup", 1, TRUE, "Your tooltip text")

→   fgl_dialog_setkeylabel():

CALL fgl_dialog_setkeylabel("F1","F1 toolbarKey", "images/css-24.png", 3, TRUE, "Your tooltip text")

To remove the tooltip, you have just to remove the parameter.

Example programs:

CVS server: client.querix.com

CVS repository: /lycia_doc_examples

User: client

Project: form_properties

Program: toolTip