JVCL Help:TJvDockClient.OnFormShowHint

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

Search in JVCL Help

 
Search in all projects
 

Summary

Write here a summary (1 line)


Pascal

 TJvDockFormHintEvent = procedure (HTFlag: Integer; var HintStr: string; var CanShow: Boolean) ofobject;
propertyOnFormShowHint: TJvDockFormHintEvent;


Parameters

Parameters Description
CanShow If this parameter is changed, this information will be returned to application. CanShow parameter determines whether the hint information will be shown. When it is True, the hint information will be shown, and otherwise it won't.
HintStr If this parameter is changed by user, the information will be returned to application. Then application will show HintStr as the hint information.
HTFlag Determines position of mouse. See HitTest list for more information.


Description

OnFormShowHint event is a TFormHintEvent event. It occurs when application need to show hint information.


About

Notes

In this event, ShowHint property affects HintStr parameter and CanShow parameter. If ShowHint property is False, application will not show hint information even if HintStr isn't empty and CanShow parameter is True.
OnFormShowHint event can supports foreign language application, user can change HintStr parameter in a foreign language.


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