Welcome to the new DelphiDabbler Code Library Documentation.

This is a new site that's currently running on alpha code. There are going to be bugs. If you discover any, please report them on the site's issues page (GitHub account required). Thanks.

Warning: Many URLs are going to change. Refer to the README file to discover which library project's documentation has been completed.

TPJWinMsgDlg

Project: Message Dialogue Components.

Unit: PJMessageDialog.

Applies to: ~>3.0

TPJWinMsgDlg provides a customisable Windows message dialogue box. The component wraps the Windows MessageBoxIndirect API call.

Its properties are a subset of those of TPJVCLMsgDlg. TPJWinMsgDlg is recommended for new projects requiring a Windows message box. If even greater control over the appearance of the dialogue is required then use TPJVCLMsgDlg.

The text displayed in the dialogue box is determined by the Text property. Various button groupings can be displayed using the ButtonGroup property. Setting a non-zero HelpContext causes a help button to be displayed. The Kind property allows a choice of various standard windows icons to be displayed. A user defined icon extracted from a named resource, specified by IconResource can also be displayed. The window title can be set using the Title property, otherwise a default title, related to the kind of icon being displayed is used. The MakeSound property determines whether an appropriate system sound is generated when the dialogue is displayed.

Methods

Method Description
Execute Displays the dialogue box and returns information about the button pressed to close it.

Properties

Property Description
ButtonGroup Determines which buttons appear in the dialogue box.
DlgType Permits the buttons and type of dialogue box displayed to be specified by means of the flags that are passed to the uType parameter of the Windows MessageBox API function.
HelpContext Specifies the context number for online help and displays a help button.
HelpFile Specifies the file to use for online help.
IconResource Specifies the resource containing the dialogue box’s icon.
Kind Determines the type of dialogue box that is displayed.
MakeSound Flag that determines if a sound will be emitted when the dialogue box is displayed.
Text The text that is displayed in the dialogue box.
Title The dialogue box’s window title.

Events

Event Description
OnHelp Event triggered when a user requests help in a dialogue box.