dxMessageDlgPosHelp(string,TMsgDlgType,TMsgDlgButtons,Longint,Integer,Integer,string,TdxMessageDialogHyperlinkClickDelegate,TdxMessageDialogShowHyperlinkHintDelegate) Method

Invokes a message dialog box whose help topic is supplied in a specified help file.

Declaration

function dxMessageDlgPosHelp(const AMessage: string; ADialogType: TMsgDlgType; AButtons: TMsgDlgButtons; AHelpContext: Longint; X: Integer; Y: Integer; const AHelpFileName: string; const AHyperlinkClickProc: TdxMessageDialogHyperlinkClickDelegate = nil; const AShowHyperlinkHintProc: TdxMessageDialogShowHyperlinkHintDelegate = nil): Integer;

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 predefined caption, system icon, and sound of the message dialog box.
AButtons	TMsgDlgButtons	A set of buttons on the message dialog box form.
AHelpContext	Longint	A context ID of the help topic that a click on the Help button or the F1 keystroke should invoke while the message box is displayed.
X	Integer	A horizontal offset (in pixels) of the upper-left form corner from the upper-left screen corner. -1 corresponds to the default horizontal message box position.
Y	Integer	A vertical offset (in pixels) of the upper-left form corner from the upper-left screen corner. -1 corresponds to the default vertical message box position.
AHelpFileName	string	The name of the help file that contains the target help topic of the message dialog box.
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
Integer	An integer value that indicates the button clicked to close the message box. The dxMessageDlgPosHelp function returns 0 if it fails to invoke a message box. Refer to the list of possible returned values in the Remarks section.

Remarks

Call the dxMessageDlgPosHelp function to invoke a message dialog box associated with a help topic. 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]'

Returned Values

IDOK

A user clicked the OK button to close the message box.

IDCANCEL

A user clicked the Cancel button to close the message box.

IDABORT

A user clicked the Abort button to close the message box.

IDRETRY

A user clicked the Retry button to close the message box.

IDIGNORE

A user clicked the Ignore button to close the message box.

IDYES

A user clicked the Yes button to close the message box.

IDNO

A user clicked the No button to close the message box.