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.

ButtonGroup property

Project: Message Dialogue Components.

Unit: PJMessageDialog.

Class: TPJWinMsgDlg

Applies to: ~>3.0

type
  TPJMsgDlgButtonGroup = (
    bgAbortRetryIgnore, bgOK, bgOKCancel, bgRetryCancel, bgYesNo, bgYesNoCancel,
    bgUnknown, bgCancelTryContinue
  );

property ButtonGroup: TPJMsgDlgButtonGroup;

Description

The buttons which appear in the dialogue box depend on the value of this property. The possible values are:

Value Buttons used
bgAbortRetryIgnore Abort, Retry and Ignore buttons.
bgOK A single OK button.
bgOKCancel An OK and a Cancel button.
bgRetryCancel A Retry and a Cancel button.
bgYesNo A Yes and a No button.
bgYesNoCancel Yes, No and Cancel buttons.
bgUnknown An unsupported or unknown group of buttons. This item is for use in TPJVCLMsgDlg and should not be selected in TPJWinMsgDlg. If it is selected it has the same effect as bgOK.
bgCancelTryContinue Cancel, Try Again and Continue buttons. This button group requires the Windows NT platform and Windows 2000 or later. Behaves as bgAbortRetryIgnore when specified on OSs that do not support this button group.

Setting ButtonGroup also updates the DlgType property and vice versa. See the DlgType page for full details.

To include a help button in the dialogue box set the HelpContext property to some non-zero value.

A value associated with the button that was clicked is returned from the Execute method.

The default value of the property is bgOK.