JVCL Help:TJvTabBarItem.Hint

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Text displayed when the user moves the mouse over the control.


Pascal

 propertyHint: TCaption;


Description

Hint is a String property that provides a string of help text either as a Help Hint, or for display on a status bar. A Help Hint is a box containing help text that appears for a control when the user moves the mouse pointer over the control and pauses momentarily.
Set the ShowHint property to True, or set the ParentShowHint property to True. At run-time, set the value of the application's ShowHint property to true.
To show the Hint on a status bar, use the OnHint event handler of the application. The application’s OnHint event occurs when the mouse pointer moves over the control.
Hint can be used to specify both a Help Hint box and long help message for an OnHint handler by specifying two values separated by a "|" character (the vertical bar “or” symbol).
ATabItem.Hint := 'Tab Item|This is information about the tab item.';
If Hint contains only one value, the entire string is used as a Help Hint and returned by the GetLongHint function. If a control has no Hint value specified, but its parent control does, the control uses the Hint value of the parent control (as long as the control's ShowHint property is true).
Please note that when the application's ShowHint property is false, the Help Hint does not appear, but the OnHint event handler is still called.


See Also

TJvTabBarItem.ShowHint, ,


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page