|
|
|
|
- Overview
- How to?
- Customizing tooltips
- Special case: Use an application window to customize tooltips
- WLanguage functions and properties
Tooltips are very useful for application users. From version 26, tooltips can be customized: use custom tooltips to display your messages. Several types of tooltips are available: - Standard tooltips:
- Skin template tooltips:
- Custom style tooltips:
- Tooltips customized via an application window.
Reminder: The text displayed in the tooltip can be: - Entered in the editor:
- Open the control description window (select "Description" in the context menu).
- In the "Help" tab, in the "Tooltip" area, type the text of the tooltip.
Remarks: - In a multilingual application, the text of the tooltip can be typed in several languages.
- If the "RTF" option is checked, the text can be formatted via the options of the RTF toolbar. The formatting will be maintained at runtime.
- Specified via the ToolTip property.
Remarks: - Custom tooltips are used for all tooltips in the application:
- Control tooltips.
- Automatic tooltips for Table and List controls (displayed if the text is not complete in the control, for example).
- Custom tooltips are not used in the following cases:
- Chart control tooltips.
- Scrollbar tooltips.
- If your users customize the tooltip text via the AAf, the custom text will be displayed in the custom tooltip.
Customizing tooltips To customize tooltips in your application: - Open the project description window: on the "Project" tab, in the "Project" group, click "Description".
- In the "Style" tab, specify the type of tooltip to be used in the project:
- Standard: standard tooltips with a yellow background are used.
- Defined by the skin template: the tooltips from the skin template used by the project are used.
- Custom: the tooltip style editor opens and shows various customization options:
You can customize: - The text displayed: font, size, shadow, color, etc.
- The borders of the tooltip: margins, background color, border type, etc.
- Window: You can select a window in your project to display the help as a tooltip. This option allows to create all possible UIs.
- Validate the project description window. All tooltips displayed by your application will use the selected look.
Remark: Tooltips can be displayed with an animation. To activate this animation: - Open the project description window: on the "Project" tab, in the "Project" group, click "Description".
- In the "Advanced" tab, click "Animations of controls".
- In "Tooltip", select and configured the desired animation.
- Validate.
- Validate the project description window.
Special case: Use an application window to customize tooltips WINDEV allows using a window of the application to display the content of the tooltips. In this case: - Only the declaration code of global variables of the window is executed.
- The declaration code of global variables of a window must contain the following code:
PROCEDURE DeclarationWindowGlobalVariables(TooltipText, SourceControl) STC_TOOLTIP = TooltipText where: - TooltipText is the text to be displayed in the tooltip. This text must be displayed in a Static control in the window (for example, STC_TOOLTIP).
- SourceControl is an optional parameter that contains the name of the control for which the tooltip is displayed.
- The option "Adapt the size according to the content" ("General" tab of the description window) must be checked.
- The window must use a background image with the clipping option enabled ("Clip the window (uses the transparency mode of the background image)" in the "Image tab of the description window).
- To display text with effects in the tooltip, you can, for example: This information must be specified in the tooltip of the control (e.g., in the "Help" tab of the control description window, or via the ToolTip property of the control).
- The "Modifier" pane contains specific options for windows displayed in tooltip mode. These options are as follows:
- "Tooltip mode": Enables or disables the tooltip display mode. If this mode is enabled, the other options of the tooltip mode will be taken into account.
- "Tooltip mode: X offset": Defines the X offset of the window (displayed as a tooltip) relative to the mouse cursor. The mouse cursor corresponds to the point (0,0).
- "Tooltip mode: Y offset": Defines the Y offset of the window (displayed as a tooltip) relative to the mouse cursor. The mouse cursor corresponds to the point (0,0).
- "Tooltip mode: Hot spot": Defines the point of the window (displayed as a tooltip) that will be displayed at the mouse cursor position. This option allows creating speech bubble-like tooltips.
WLanguage functions and properties Several WLanguage functions and properties can be used to configure tooltips. The following functions and properties can be used on custom tooltips: - WLanguage functions:
| | ShowToolTip | Enables or disables the mechanism for displaying the control tooltips. | ToolTipDelay | Used to modify:- the timeout before displaying the tooltips.
- the display duration of the tooltips.
| TooltipMaxWidth | Modifies the maximum width of tooltips. |
- WLanguage properties:
| | AutomaticTooltip | The AutomaticTooltip property is used enable or disable automatic tooltips on List Box, Table and TreeView Table controls. | ToolTip | The ToolTip property is used to get and change the text displayed in the tooltip associated with a window or page control. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|