dxCreateMessageDialog(string,TMsgDlgType,TMsgDlgButtons,TMsgDlgBtn,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate) Method

Creates a message dialog box form with specified settings.

Declaration

function dxCreateMessageDialog(const AMessage: string; ADialogType: TMsgDlgType; AButtons: TMsgDlgButtons; ADefaultButton: TMsgDlgBtn; const AHyperlinkClickProc: TdxMessageDialogHyperlinkClickDelegate = nil; const AShowHyperlinkHintProc: TdxMessageDialogShowHyperlinkHintDelegate = nil): TdxMessageDialogForm;

Parameters

Name	Type	Description
AMessage	string	Message dialog box content. The AMessage parameter value initializes the created form’s Message property. The AMessage parameter supports a set of BBCode-inspired tags that allow you to format message box content. Refer to the Remarks section for the full list of supported formatting tags.
ADialogType	TMsgDlgType	A message dialog box type that determines the predefiend caption, system icon, and sound of the message dialog box.
AButtons	TMsgDlgButtons	A set of buttons on the message dialog box form.
ADefaultButton	TMsgDlgBtn	A button type. Use this parameter to specify the button that has focus when the message box appears.
AHyperlinkClickProc	TdxMessageDialogHyperlinkClickDelegate	Optional. Specifies a procedure that handles a click on a hyperlink within the displayed message. The AHyperlinkClickProc parameter value initializes the HyperlinkClickProc property of the created message dialog box form. You can define a click handler procedure to identify the clicked hyperlink and prevent certain links from being activated. Tip Refer to the TdxMessageDialogHyperlinkClickDelegate procedural type description for detailed information and a code example.
AShowHyperlinkHintProc	TdxMessageDialogShowHyperlinkHintDelegate	Optional. Specifies a procedure that handles a hyperlink hint display event. The AShowHyperlinkHintProc parameter value initializes the ShowHyperlinkHintProc property of the created message dialog box form. You can define a hyperlink hint handler procedure to change the predefined hint message (the hyperlink target URI) depending on certain conditions in your application. Tip Refer to the TdxMessageDialogShowHyperlinkHintDelegate procedural type description for detailed information and a code example.

Returns

Type	Description
TdxMessageDialogForm	The created message dialog box form.

Remarks

You can call the dxCreateMessageDialog function instead of the TdxMessageDialogForm constructor. The created message dialog box has the mdsMessageDlg style.

Supported BBCode-Inspired Markup Tags

Text Formatting Attribute	Message Text with Tags	Example
Bold	'[B]DevExpress[/B]'
Italic	'[I]DevExpress[/I]'
Underscore	'[U]DevExpress[/U]'
Strikeout	'[S]DevExpress[/S]'
Subscript	'Dev[Sub]Express[/Sub]'
Superscript	'Dev[Sup]Express[/Sup]'
Custom Font	'Dev[U][Font=Consolas][Size=12]Express[/U][/Font][/Size]'
Color	'[Color=#E67E22]Dev[/Color][Color=Gray]Express[/Color]'
Background Color	'[BackColor=Orange]DevExpress[/BackColor]'
Hyperlink	'[URL=http://www.devexpress.com/]DevExpress[/URL]'
No Parse	'[NOPARSE][B]DevExpress[/B][/NOPARSE]'

Code Example: Create a Message Box with Custom Button Captions

The following code example calls the dxCreateMessageDialog function to create a message box with Yes, No, and Cancel buttons, customizes their captions, and moves focus to the Cancel button:

Delphi

uses dxMessageDialog;
// ...
var
  ADialog: TdxMessageDialogForm;
  AMessage: string;
begin
  AMessage := 'One or more margins are set outside the printable area of the page.' + #13#10 +
    'Click the [B]Fix[/B] button to increase these margins.';
  ADialog := dxCreateMessageDialog(AMessage, mtWarning, mbYesNoCancel, mbCancel);
  try
    ADialog.FindButton(mbYes).Caption := 'Fix';
    ADialog.FindButton(mbNo).Caption := 'Restore Original';
    ADialog.FindButton(mbCancel).Caption := 'Close';

    ADialog.AlignButtons;  // Recalculates the button layout
    ADialog.ShowModal;     // Invokes the form as a modal dialog
  finally
    ADialog.Free;  // Releases the message box form once a user closes it
  end;
end;

C++

#include "dxMessageDialog.hpp"
// ...
  TdxMessageDialogForm *ADialog;
  UnicodeString AMessage = "One or more margins are set outside the printable area of the page.\n" +
    "Click the [B]Fix[/B] button to increase these margins.";
  ADialog = dxCreateMessageDialog(AMessage, wtWarning, mbYesNoCancel, mbCancel);
  try
  {
    ADialog->FindButton(mbYes)->Caption = "Fix";
    ADialog->FindButton(mbNo)->Caption = "Restore Original";
    ADialog->FindButton(mbCancel)->Caption = "Close";

    ADialog->AlignButtons();  // Recalculates the button layout
    ADialog->ShowModal();     // Invokes the form as a modal dialog
  }
  __finally
  {
    delete ADialog;  // Releases the message box form once a user closes it
  }

Limitation

The dxUseStandardMessageDialogs global variable has no effect on dxCreateMessageDialog function calls.