JVCL Help:TJvBalloonHint.ActivateHintPos

 JVCL Help: TJvBalloonHint.ActivateHintPos Method

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 hint window at a specified position.

Pascal

 procedureActivateHintPos(AAnchorWindow: TCustomForm; AAnchorPosition: TPoint; constAHeader: WideString; constAHint: WideString; constVisibleTime: Integer = cJvBallonHintVisibleTimeDefault; constAIconKind: TJvIconKind = ikInformation; constAImageIndex: TImageIndex = -1);

Parameters

Parameters	Description
AAnchorWindow: TCustomForm	The window where to the balloon window is anchored to. The component will ensure that the balloon window maintains its position relative to the anchor window. May be set to nil.
AAnchorPosition: TPoint	The position of the balloon's stem point within the client rectangle of the window specified by AAnchorWindow.
const AHeader: WideString	The header for the balloon.
const AHint: WideString	The hint message for the balloon.
const VisibleTime: Integer = cJvBallonHintVisibleTimeDefault	The maximum time in milliseconds that the balloon is visible.
const AIconKind: TJvIconKind = ikInformation	The icon to be displayed in the balloon.
const AImageIndex: TImageIndex = -1	Indicates which image to draw in the balloon from the image list Images.

Description

Call ActivateHintPos to display the balloon window with its stem point at the coordinate provided by the AAnchorPosition parameter.
ActivateHintPos 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. Set VisibleTime to 0 to disable theautomatic deactivation.
  

To hide a balloon window that is activated directly by calling ActivateHint, ActivateHintPos and ActivateHintRect, use the CancelHint method.
You may set parameter AAnchorWindow to nil, then AAnchorPosition is a position on the desktop.
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.ActivateHint

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