CommonButtons Property

Description

Specifies the "common" push buttons displayed in the task dialog. If no common buttons are specified and no custom buttons are specified using the AddButton method, the task dialog will contain the "OK" button by default.

Property Type

Read-write property

Syntax (Visual Basic)

Public Property CommonButtons() As [TaskDialogCommonButtons](XtremeSuiteControls~Enumerations~TaskDialogCommonButtons_EN.md)

Remarks

Any combination of flags from the TaskDialogCommonButtons enumeration can be used to add common buttons to the task dialog. If the Cancel button is specified, the task dialog will respond to typical cancel actions (Alt-F4 and Escape).

The illustration below shows a dialog that has all common buttons added:

Common Buttons Dialog

You can mix both user-defined buttons, radio buttons, common buttons, and command links. The AddButton method adds a user-defined button to the task dialog's command area. The AddRadioButton method adds a user-defined radio button to the task dialog's command area.

The EnableCommandLinks property specifies whether the buttons specified with AddButton should be displayed as command links (using a standard task dialog glyph) instead of push buttons. When using command links, all characters up to the first new line character in AddButton's Text argument will be treated as the command link's main text, and the remainder will be treated as the command link's note text.

The illustration below shows command links without icons:

Command Links

Example

Adding Common Buttons (Visual Basic)

This sample illustrates how to add the Yes and OK common buttons.

taskDialog.CommonButtons = 0  
taskDialog.CommonButtons = taskDialog.CommonButtons Or xtpTaskButtonOk  
taskDialog.CommonButtons = taskDialog.CommonButtons Or xtpTaskButtonYes