dxMessageDlg(string,TMsgDlgType,TMsgDlgButtons,Longint,TMsgDlgBtn) Method
Invokes a modal message box dialog.
Declaration
function dxMessageDlg(const AMessage: string; ADialogType: TMsgDlgType; AButtons: TMsgDlgButtons; AHelpContext: Longint; ADefaultButton: TMsgDlgBtn): Integer;
Parameters
Name | Type | Description |
---|---|---|
AMessage | string | Content of the message dialog box. |
ADialogType | TMsgDlgType | The type of the message dialog box. This type determines the predefined caption, system icon, and sound of the message box. |
AButtons | TMsgDlgButtons | A set of buttons on the message dialog box form. |
AHelpContext | Longint | A context ID for the help topic that a click on the Help button or the F1 keystroke should invoke while the message box is displayed. |
ADefaultButton | TMsgDlgBtn | A button type. Use this parameter to specify the button that has focus when the message box appears. |
Returns
Type | Description |
---|---|
Integer | An integer value that indicates the button clicked to close the message box. The dxMessageBox function returns 0 if it fails to invoke a message box. Refer to the list of possible return values below. |
Remarks
Call this function to invoke a generic dialog box with a message and one or more buttons. The created message dialog box has the mdsMessageDlg style.
Return 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.