Vcl.Controls.TControl.Hint

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

property Hint: string read FHint write FHint stored IsHintStored;

C++

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

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
property published
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls TControl

Beschreibung

Hint enthält den String, der angezeigt wird, wenn sich der Mauszeiger über dem Steuerelement befindet.

Mit der Eigenschaft Hint können Sie einen String zuweisen, der als Hilfehinweis oder an einer bestimmten Position (z.B. Statusleiste) als Hilfetext angezeigt wird.

Ein Hilfehinweis ist ein Feld mit einem Hilfetext. Es wird eingeblendet, wenn sich der Mauszeiger eine kurze Zeit über dem Steuerelement befindet.

So richten Sie Hilfehinweise ein:

  • Geben Sie die Eigenschaft Hint jedes Steuerelements an, für die ein Hilfehinweis angezeigt werden soll.
  • Setzen Sie die Eigenschaft ShowHint der betreffenden Steuerelemente auf True. Sie können dazu auch die Eigenschaft ParentShowHint aller Steuerelemente auf True und dann die Eigenschaft ShowHint des Formulars auf True setzen.
  • Setzen Sie zur Laufzeit die Eigenschaft ShowHint der Anwendung auf True.
  • Um den Hilfehinweis (Hint) in der Statusleiste oder an einer anderen Position anzuzeigen, verwenden Sie die Behandlungsroutine OnHint der Anwendung. Das Ereignis OnHint der Anwendung wird ausgelöst, sobald der Mauszeiger über das Steuerelement bewegt wird.
  • Durch die Angabe von zwei Werten, die durch das Zeichen | voneinander getrennt sind, kann ein Kurzhinweis definiert werden, der sowohl vom Hilfetextfeld (Hint) als auch von einer Ereignisbehandlungsroutine für OnHint verwendet wird.

Beispiel:

Edit1.Hint := 'Name|Geben Sie den Namen in das Eingabefeld ein';
Edit1->Hint = "Name|Geben Sie den Namen in das Eingabefeld ein";

Hier:

  • Der Text Name ist der kurze Hinweis und wird im Hilfetextfeld (Hint) angezeigt.
  • Der String Geben Sie einen Namen ein ist der lange Hinweis und wird unter dem kurzen Hinweis angezeigt. Dieser kann mit Hilfe der Funktion GetLongHint für die Verwendung in der OnHint-Ereignisbehandlungsroutine extrahiert werden
  • 1 ist ein optionaler Bildindex in der Bildliste der Eigenschaft Images des Steuerelements und gibt den Index des Bildes an, das im Hinweis angezeigt wird.

Wenn Hint nur einen Wert enthält, wird der gesamte String als Hilfehinweis verwendet und von der Funktion GetLongHint zurückgegeben. Wenn für ein Steuerelement kein Wert für Hint angegeben ist, aber für dessen übergeordnetes Objekt ein Hinweis Hint existiert, verwendet das Steuerelement den Wert Hint des übergeordneten Objekts. Voraussetzung dafür ist, dass die Eigenschaft ShowHint des Steuerelements auf True gesetzt ist.

Hinweis: Hat die Eigenschaft ShowHint der Anwendung den Wert False, wird zwar kein Hilfetext Hint angezeigt, aber dennoch die Ereignisbehandlungsroutine für OnHint aufgerufen.

Siehe auch

Codebeispiele