Welcome to the new DelphiDabbler Code Library Documentation.

This is a new site that's currently running on alpha code. There are going to be bugs. If you discover any, please report them on the site's issues page (GitHub account required). Thanks.

Warning: Many URLs are going to change. Refer to the README file to discover which library project's documentation has been completed.

OnCustomHint event

Project: Hot Label Component.

Unit: PJHotLabel.

Class: TPJHotLabel

Applies to: ~>2.0

  TPJHLCustomHintEvent = procedure(
    Sender: TObject; var HintStr: string
  ) of object;

property OnCustomHint: TPJHLCustomHintEvent;


OnCustomHint is an event that enables the user to specify a custom hint to be displayed by the component.

This event is triggered only when the HintStyle property is set to hsCustom and a hint is about to be displayed. Handling the event enables the user to specify the text that is displayed in the pop-up hint. The event handler is passed the current Hint property value in the HintStr parameter. Specify the hint text by setting HintStr to the required value.

If HintStyle is hsCustom and the event is not handled then the value of the Hint property is displayed as normal.

See the Using the OnCustomHint event example for one possible use of the OnCustomHint event.