XtraBaseArgs.DefaultButtonIndex Property

Gets or sets the index of a button from the Buttons collection that is a default button. A default button is initially focused and is considered clicked when user presses Enter or the auto-close timer expires (see AutoCloseOptions).

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public int DefaultButtonIndex { get; set; }

VB.NET

Public Property DefaultButtonIndex As Integer

Property Value

Type	Description
Int32	The index of a default button.

Remarks

The code below shows the XtraInputBox with “OK”, “Cancel” and “Retry” buttons. The “Retry” button is a default button - if a user presses Enter when the input box is shown, the input box closes and returns DialogResult.Retry.

C#

XtraInputBoxArgs xia = new XtraInputBoxArgs();
(xia as XtraBaseArgs).Buttons = new DialogResult[] {
    DialogResult.OK, DialogResult.Cancel, DialogResult.Retry };
xia.DefaultButtonIndex = 2;
xia.Caption = "User not found. Enter a valid user name.";
XtraInputBox.Show(xia);

VB.NET

Dim xia As New XtraInputBoxArgs()
TryCast(xia, XtraBaseArgs).Buttons = New DialogResult() {
    DialogResult.OK, DialogResult.Cancel, DialogResult.Retry }
xia.DefaultButtonIndex = 2
xia.Caption = "User not found. Enter a valid user name."
XtraInputBox.Show(xia)