Vcl.Controls.TControl.Hint

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi 

property Hint: string read FHint write FHint stored IsHintStored;

C++ 

__property System::UnicodeString Hint = {read=FHint, write=FHint, stored=IsHintStored};

Propriétés

Type Visibilité  Source Unité  Parent
property published
Vcl.Controls.pas
Vcl.Controls.hpp
 Vcl.Controls TControl

Description

Hint contient la chaîne de texte apparaissant lorsque l'utilisateur déplace la souris au-dessus du contrôle.

Utilisez la propriété Hint pour spécifier une chaîne de texte d'aide comme texte de conseil ou comme texte d'aide affiché à un endroit spécifique, par exemple sur la barre d'état.

Un conseil est une boîte affichant un texte d'aide à propos d'un contrôle, qui apparaît si l'utilisateur maintient momentanément le pointeur de la souris au-dessus du contrôle.

Pour mettre en place les conseils :

  • Spécifiez la propriété Hint de chaque contrôle pour lequel un conseil d'aide doit apparaître.
  • Affectez True à la propriété ShowHint de chaque contrôle approprié, ou affectez True à la propriété ParentShowHint de tous les contrôles et définissez la propriété ShowHint de la fiche à True.
  • A l'exécution, affectez True à la valeur de la propriété ShowHint de l'application.
  • Pour afficher le conseil dans une barre d'état ou à un autre emplacement, utilisez le gestionnaire d'événements OnHint de l'application. L'événement OnHint de l'application est déclenché quand le pointeur de la souris passe au-dessus du contrôle.
  • Spécifiez un conseil à utiliser pour la boîte du conseil d'aide et par le gestionnaire d'événements OnHint en indiquant des valeurs séparées par le caractère | (barre verticale).

Par exemple, 

Edit1.Hint := 'Nom|Entrez le nom dans la boîte de saisie|1';

Edit1->Hint = "Nom|Entrez le nom dans la boîte de saisie|1";

Dans ce cas :

  • La chaîne Nom est le conseil court et apparaît dans la partie supérieure de la boîte du conseil d'aide.
  • La chaîne Entrez le nom dans la boîte de saisie est le conseil long et apparaît au-dessous du conseil court. Elle peut être extraite en utilisant la fonction GetLongHint pour l'utiliser dans un gestionnaire d'événements OnHint.
  • 1 est un index d'image facultatif dans une liste d'images de la propriété Images du contrôle et spécifie l'index de l'image qui doit apparaître dans le conseil.

Si Hint ne contient qu'une valeur, la chaîne entière est utilisée comme conseil d'aide et est renvoyée par les fonctions GetLongHint et GetShortHint. Si un contrôle n'a pas de valeur Hint spécifiée, mais que son contrôle parent l'ait, le contrôle utilise la valeur du contrôle parent (tant que la propriété ShowHint du contrôle a la valeur True).

Remarque :  Si la propriété ShowHint de l'application a la valeur False, le conseil d'aide n'apparaît pas, mais le gestionnaire d'événements OnHint est toujours appelé.

Voir aussi

Exemples de code


Récupérée de « https://docwiki.embarcadero.com/Libraries/Tokyo/f/index.php?title=Vcl.Controls.TControl.Hint&oldid=578619 »