JVCL Help:TJvBalloonHint.ActivateHint@TControl@WideString@WideString@Integer

 JVCL Help: TJvBalloonHint.ActivateHint Method (TControl, WideString, WideString, Integer)

TJvBalloonHint

► TJvBalloonHint Methods

[+] TJvBalloonHint Methods

► TJvBalloonHint Properties

[+] TJvBalloonHint Properties

JEDI Visual Component Library Help

• Packages
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JVCL Help

 

Search in all projects

 

Summary

Displays a balloon window anchored to a control.

Pascal

 procedureActivateHint(ACtrl: TControl; constAHint: WideString; constAHeader: WideString = ; constVisibleTime: Integer = cJvBallonHintVisibleTimeDefault); overload;
procedureActivateHint(ACtrl: TControl; constAHint: WideString; constAImageIndex: TImageIndex; constAHeader: WideString = ; constVisibleTime: Integer = cJvBallonHintVisibleTimeDefault); overload;
procedureActivateHint(ACtrl: TControl; constAHint: WideString; constAIconKind: TJvIconKind; constAHeader: WideString = ; constVisibleTime: Integer = cJvBallonHintVisibleTimeDefault); overload;

Parameters

Parameters	Description
ACtrl: TControl	The anchor control for the balloon. Depending on the value of DefaultBalloonPosition, the balloon is placed below or above this control. The component will ensure that the balloon window maintains its position relative to the parent window of this control.
const AHint: WideString	The hint message for the balloon.
const AHeader: WideString =	The header for the balloon.
const VisibleTime: Integer = cJvBallonHintVisibleTimeDefault	The maximum time in milliseconds that the balloon is visible.
const AImageIndex: TImageIndex	Indicates which image to draw in the balloon from the image list Images.
const AIconKind: TJvIconKind	The icon to be displayed in the balloon.

Description

Call ActivateHint to display the balloon window anchored to a control specified by the ACtrl parameter.
ActivateHint ensures that the balloon window appears entirely on screen.
After the component displays a balloon window, it automatically deactivates it after a time period

• specified by the VisibleTime parameter - has elapsed, or when it receives a message that requireshiding the hint message. Set VisibleTime to 0 to disable the automatic deactivation.
  

To hide a balloon window that is activated directly by calling ActivateHint, ActivateHintPos or ActivateHintRect, use the CancelHint method.
Use Options to specify that the component must use default values as specified by DefaultHeader, DefaultImageIndex and DefaultIcon, instead of the values of the parameters that may be given.

See Also

TJvBalloonHint.ActivateHintPos, TJvBalloonHint.ActivateHintRect, TJvBalloonHint.CancelHint

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

The JEDI Visual Component Library source is hosted at : link to view the current source code, link to the subversion repository