Control tooltips (AAF)

AYUDA EN LÍNEA
WINDEV, WEBDEV Y WINDEV MOBILE

Versión:

Inicio | Iniciar sesión | Español

Ayuda / Funcionalidades Automáticas de la Aplicación (FAA)

Overview
How to?
Implementation
Getting changes

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Control tooltips (AAF)

Overview

In a WINDEV application, users can add a tooltip on the controls.

If the tooltip proposed by default is not ideal, they can change it. Furthermore, they can even add a tooltip if there is none.

Reminder: The button tooltip is defined in the "Help" tab of the control description window ("Tooltip" option).

How to?

To modify the control tooltip, the user can:

Select "Edit tooltip" in the context menu of the control.
The tooltip text is displayed in modification.
Use the interface customization:
- Change to edit mode ("Customize interface .. Change to edit mode" in the context menu of the window).
- Right-click the control to open the context menu and select "Edit tooltip".
- The tooltip text is displayed in modification.

Remarks:

If the tooltip is modified by the developer (application update), the customization is deleted.
In a multilingual application, the tooltip customization is performed for all languages.
The tooltip customization is ignored for some types of controls: Map, HTML, ActiveX, Cube, etc.
In Check Box and Radio Button controls, the tooltip customization modifies the tooltip of the control, and not of the options.
To communicate the modifications performed to the developer, all you have to do is create a ".wdmodif" export file. This file will contain all interface modifications performed in the window. To create this file:
- Open the context menu and select "Customize interface .. Export the customization of this window" or "Customize interface .. Export all the customizations of the application".
- Modify (if necessary) the name of created file and validate.
- Transfer the file to the developer.

Implementation

Tooltip modification at runtime is a feature linked to interface modification at runtime (for more details, see UI modifiable by the end user). From version 21, this option is automatically proposed in the applications created or compiled with version 21.

To configure this option:

Choose whether the option must be configured for the project or for the window:
- for the project. This option will be taken into account for all project windows:
  1. Open the project description window. To do so, go to the "Project" tab, "Project" group, and click "Description".
  2. On the "Advanced" tab, check "Allow end users to modify the UI" if necessary.
- for each window. This option will be taken into account for the selected window only:
  1. Open the window description ("Description" from the window context menu).
  2. On the "Details" tab, check "Allow end users to modify the UI" if necessary.
The "Options" button is used to specify the authorized options.
To allow tooltip modification, "Edit tooltip" must be checked in the options defined for the project, or in the specific options of the window or project.
If this option is unchecked, the end user will not be able to edit the tooltip of controls.

Remarks:

If the option to change the tooltip is enabled, you can disable the option directly for some types of controls ("Edit tooltip" option available in the context menu of the control), in the project or the controls in the window. For more details, see Configuring the AAF context menu. The user will have to use the "Interface customization" mode to edit the tooltip of controls.
To programmatically enable or disable the option to change tooltips in a window, you can use the WinEditMode property with the weChangeTooltip constant:
```
MyWindow.WinEditMode = weChangeTooltip
```

Getting changes

To get end-user changes to tooltips (as well as other UI changes), simply open the "wdmodif" extension file in WINDEV:

by dragging and dropping the file onto the editor.
via the "Open" option in the ribbon. On the "Home" tab, in the "General" group, expand "Open", click "Open", and select the file.

The window that is displayed lists the different modified windows as well as the modification performed.

All you have to do is select the requested modifications in order to apply them to the corresponding windows.

Remarks:

The corresponding project must be opened in the editor.
If the window to modify is not opened in the editor, WINDEV opens the window, applies the modifications, saves and closes the window.
If the window to modify is opened in the editor, WINDEV applies the modifications to the window. The modifications are not saved and they can be undone (Ctrl + Z).