TdxMessageDialogShowHyperlinkHintDelegate Type

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

Declaration

TdxMessageDialogShowHyperlinkHintDelegate = reference to procedure(AArgs: TdxShowHyperlinkHintEventArgs);

Parameters

Name	Type	Description
AArgs	TdxShowHyperlinkHintEventArgs	Stores information about a hyperlink hint display event 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 hyperlink defined as part of message box content displays the target URI as a hint when a user positions the mouse pointer within the hyperlink.

In this topic…

• Usage Scenario
• Handler Execution Trigger
• Available Handler Parameters
• Code Example: Prevent Accidental Hyperlink Activation in Message Boxes
• Direct TdxMessageDialogShowHyperlinkHintDelegate 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 TdxMessageDialogShowHyperlinkHintDelegate type and pass it as the AShowHyperlinkHintProc parameter of any message box creation method to modify hint content before it is displayed.

Handler Execution Trigger

An assigned hint display handler is executed every time a hint for a hyperlink defined within message box content is about to appear.

Available Handler Parameters

The following parameters are available within a hint display handler:

AArgs.Hint

Allows you to modify hint content before it is displayed.

AArgs.URI

Returns the target hyperlink’s URI.

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

Code Example: Prevent Accidental Hyperlink Activation in Message Boxes

The code example in this section demonstrates TdxMessageDialogHyperlinkClickDelegate and TdxMessageDialogShowHyperlinkHintDelegate handlers. The TdxMessageDialogHyperlinkClickDelegate handler requires a user to hold down the Ctrl key to activate a hyperlink. The TdxMessageDialogShowHyperlinkHintDelegate handler changes all hyperlink hints to prompt a user to hold the Ctrl key for hyperlink activation.

Delphi

procedure TMyForm.LinkClickHandler(AArgs: TdxHyperlinkClickEventArgs);
begin
  if AArgs.Shift <> [ssCtrl] then // If the Ctrl key is not held down
    AArgs.Handled := True;  // Prevents hyperlink activation
end;

procedure TMyForm.LinkHintHandler(AArgs: TdxShowHyperlinkHintEventArgs);
var
  AHintPrefix, AHintURI: string;
begin
  AHintPrefix := 'Ctrl-click to navigate to ';
  AHintURI := AArgs.URI.Remove(0, 8);  // Removes the URI scheme from the hyperlink hint
  AArgs.Hint := AHintPrefix + AHintURI;  // Redefines the hyperlink hint
end;

// This procedure displays a message box with dynamic content and prevents MAILTO links from being opened
procedure TMyForm.ShowMyMessage(const AMessage: string; const ALink: string);
begin
  dxCreateMessageDialog(AMessage + #13#10 + ' [URL=' + ALink + ']' + ALink + '[/URL]',
    LinkClickHandler, LinkHintHandler);
end;

C++

void __fastcall TMyForm::LinkClickHandler(TdxHyperlinkClickEventArgs *AArgs)
{
  if(AArgs->Shift != (TShiftState() << [ssCtrl]))  // If the Ctrl key is not held down
    AArgs->Handled = true;  // Prevents hyperlink activation
}

void __fastcall TMyForm::LinkHintHandler(TdxShowHyperlinkHintEventArgs *AArgs)
{
  UnicodeString AHintPrefix, AHintURI;
  AHintPrefix = "Ctrl-click to navigate to ";
  AHintURI = AArgs->URI.Remove(0, 8);  // Removes the URI scheme from the hyperlink hint
  AArgs->Hint = AHintPrefix + AHintURI;  // Redefines the hyperlink hint
}

// This procedure displays a message box with dynamic content and prevents MAILTO links from being opened
void __fastcall TMyForm::ShowMyMessage(const UnicodeString &AMessage, const UnicodeString &ALink)
{
  dxCreateMessageDialog(AMessage + "\n" + " [URL=" + ALink + "]" + ALink + "[/URL]",
    LinkClickHandler, LinkHintHandler);
}

Direct TdxMessageDialogShowHyperlinkHintDelegate Type References

The following global methods reference the TdxMessageDialogShowHyperlinkHintDelegate procedural type as the AShowHyperlinkHintProc 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.ShowHyperlinkHintProc property references the TdxMessageDialogHyperlinkClickDelegate procedural type. All message dialog box creation methods initialize this property using the AHyperlinkClickProc 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.

TdxMessageDialogShowTextHintDelegate

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