TdxMessageDialogShowTextHintDelegate Type

The procedural type for a hint-marked text range hint display handler in a message dialog.

Declaration

TdxMessageDialogShowTextHintDelegate = reference to procedure(AArgs: TdxShowTextHintEventArgs);

Parameters

Name	Type	Description
AArgs	TdxShowTextHintEventArgs	Stores information about a hint display event for a hint-marked text range in a DevExpress control with support for BBCode-inspired text formatting markup.

Remarks

DevExpress message dialog boxes support BBCode-inspired markup tags for content formatting:

Delphi

dxMessageBox('Read the [URL=https://www.devexpress.com/VCL]DevExpress VCL Documentation[/URL]',
  'Note', MB_OK or MB_ICONINFORMATION);

C++

dxMessageBox("Read the [URL=https://www.devexpress.com/VCL]DevExpress VCL Documentation[/URL]",
  "Note", MB_OK | MB_ICONINFORMATION);

A message box displays a hint when a user positions the mouse pointer within a text range enclosed between [HINT] and [/HINT] tags.

In this topic…

• Usage Scenario
• Handler Execution Trigger
• Available Handler Parameters
• Code Example: Display Current Time in Text Hints
• Direct TdxMessageDialogShowTextHintDelegate Type References
  • dxCreateMessageDialog Methods
  • dxMessageBox Methods
  • dxMessageDlg Methods
  • dxMessageDlgPos Methods
  • dxMessageDlgPosHelp Methods
  • dxShowMessage Methods
  • Message Dialog Form
• Related Procedural Types

Usage Scenario

You can implement a handler of the TdxMessageDialogShowTextHintDelegate type and pass the handler to any message box creation method as the AShowTextHintProc parameter to modify displayed hint content.

Handler Execution Trigger

An assigned hint display handler is executed every time a user moves the mouse pointer into a text range enclosed between [HINT] and [/HINT] tags.

Available Handler Parameters

AArgs.Hint

Allows you to modify hint content before it is displayed.

AArgs.AnchorText | AArgs.HintIndex

Allow you to identify the target hint-marked text range in message box content.

Refer to the TdxShowTextHintEventArgs class description for detailed information on all parameters available within a hint display handler.

Code Example: Display Current Time in Text Hints

The following code example appends the current time to every hint displayed in a message box:

Delphi

uses
  dxMessageDialog;  // Declares the dxCreateMessageDialog function
// ...

procedure TMyForm.ShowTextHintHandler(AArgs: TdxShowTextHintEventArgs);
begin
  AArgs.Hint := AArgs.Hint + ' (as of ' + TimeToStr(Now) + ')';
end;

procedure TMyForm.ShowMyMessage(const AMessage: string);
begin
  dxCreateMessageDialog(AMessage, nil, nil, nil, ShowTextHintHandler);
end;

C++

#include "dxMessageDialog.hpp" // Declares the dxCreateMessageDialog method

// Add the following linker directive to the corresponding CPP source file:
#pragma link "dxMessageDialog" // Required to use dxMessageDialog.hpp declarations
// ...

void __fastcall TMyForm::ShowTextHintHandler(TdxShowTextHintEventArgs *AArgs)
{
  AArgs->Hint = AArgs->Hint + " (as of " + TimeToStr(Now()) + ")";
}

void __fastcall TMyForm::ShowMyMessage(const UnicodeString &AMessage)
{
  dxCreateMessageDialog(AMessage, nullptr, nullptr, nullptr, ShowTextHintHandler);
}

Direct TdxMessageDialogShowTextHintDelegate Type References

The following global methods reference the TdxMessageDialogShowTextHintDelegate procedural type as the AShowTextHintProc parameter:

dxCreateMessageDialog Overloads

dxCreateMessageDialog(string,TMsgDlgType,TMsgDlgButtons,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Creates a message dialog box with a specified dialog type and message. Allows you to specify a set of buttons and move focus to one of the buttons.

dxCreateMessageDialog(string,TMsgDlgType,TMsgDlgButtons,TMsgDlgBtn,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Creates a message dialog box with a specified dialog type, message, and a set of buttons.

dxMessageBox Overloads

dxMessageBox(THandle,string,string,Integer,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a message dialog box that displays a specified message, title, and buttons (configured using a combination of flags). Allows you to associate the message box with an owner window.

dxMessageBox(string,string,Integer,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a message dialog box that displays a specified message, title, and buttons (configured using a combination of flags).

dxMessageDlg Overloads

dxMessageDlg(string,TMsgDlgType,TMsgDlgButtons,Longint,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a message dialog box with a specified dialog type, message, and a set of buttons (and allows you to specify the default button).

dxMessageDlg(string,TMsgDlgType,TMsgDlgButtons,Longint,TMsgDlgBtn,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a message dialog box with a specified dialog type, message, and a set of buttons.

dxMessageDlgPos Overloads

dxMessageDlgPos(string,TMsgDlgType,TMsgDlgButtons,Longint,Integer,Integer,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a message dialog box at a specified position on the screen.

dxMessageDlgPos(string,string,TMsgDlgType,TMsgDlgButtons,Longint,Integer,Integer,TMsgDlgBtn,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a message dialog box at a specified position on the screen. Allows you to specify the default button.

dxMessageDlgPosHelp Overloads

dxMessageDlgPosHelp(string,string,TMsgDlgType,TMsgDlgButtons,Longint,Integer,Integer,string,TMsgDlgBtn,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a message dialog box associated with a help topic and positions the dialog box at specific screen coordinates.

dxMessageDlgPosHelp(string,TMsgDlgType,TMsgDlgButtons,Longint,Integer,Integer,string,TMsgDlgBtn,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a message dialog box associated with a help topic and positions the dialog box at specific screen coordinates. Allows you to specify the default button.

Miscellaneous dxShowMessage Methods

dxShowMessage(string,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a generic message dialog box with an OK button.

dxShowMessageFmt(string,Untyped[],TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a generic message dialog box with a formatted message and an OK button.

dxShowMessagePos(string,Integer,Integer,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate,TdxMessageDialogHintedTextClickDelegate,TdxMessageDialogShowTextHintDelegate)

Opens a generic message dialog box at a specified position on the screen.

Message Dialog Form

The TdxMessageDialogForm.ShowTextHintProc property references the TdxMessageDialogHyperlinkClickDelegate procedural type. All message dialog box creation methods initialize this property using the AShowTextHintProc parameter value.

Related Procedural Types

TdxMessageDialogHintedTextClickDelegate

The procedural type for a hint-marked text click handler in a message dialog.

TdxMessageDialogHyperlinkClickDelegate

The procedural type for a hyperlink activation handler in a message dialog.

TdxMessageDialogShowHyperlinkHintDelegate

The procedural type for a hyperlink hint display handler in a message dialog.