XtraDialog Class

A message box that can display any control (e.g., a UserControl) in its client area.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public static class XtraDialog

VB.NET

Public Module XtraDialog

Remarks

To display a dialog, call the static XtraDialog.Show method. Method parameters allow you to specify a control to be displayed in its client area, provide the dialog’s caption and add predefined buttons.

To learn how to customize the dialog’s buttons, see the XtraDialog.Show(DevExpress.XtraEditors.XtraDialogArgs) topic.

The following code invokes an XtraDialog displaying a UserControl with custom controls (two TextEdit controls and one CheckEdit control), and the OK and Cancel buttons.

C#

using DevExpress.XtraEditors;
using DevExpress.XtraLayout;
using System;
using System.Windows.Forms;

namespace WindowsFormsApp1 {
    public partial class Form3 : Form {
        public Form3() {
            InitializeComponent();
        }

        private void simpleButton1_Click(object sender, EventArgs e) {
            LoginUserControl myControl = new LoginUserControl();
            DevExpress.XtraEditors.XtraDialog.Show(myControl, "Sign in", MessageBoxButtons.OKCancel);
        }
    }

    public class LoginUserControl : XtraUserControl {
        public LoginUserControl() {
            LayoutControl lc = new LayoutControl();
            lc.Dock = DockStyle.Fill;
            TextEdit teLogin = new TextEdit();
            TextEdit tePassword = new TextEdit();
            CheckEdit ceKeep = new CheckEdit() { Text = "Keep me signed in" };
            lc.AddItem(String.Empty, teLogin).TextVisible = false;
            lc.AddItem(String.Empty, tePassword).TextVisible = false;
            lc.AddItem(String.Empty, ceKeep);
            this.Controls.Add(lc);
            this.Dock = DockStyle.Fill;
        }
    }
}

VB.NET

Imports DevExpress.XtraEditors
Imports DevExpress.XtraLayout
Imports System
Imports System.Windows.Forms

Namespace WindowsFormsApp1
    Partial Public Class Form3
      Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs)
            Dim myControl As New LoginUserControl()
            DevExpress.XtraEditors.XtraDialog.Show(myControl, "Sign in", MessageBoxButtons.OKCancel)
        End Sub
    End Class

    Public Class LoginUserControl
      Inherits XtraUserControl

        Public Sub New()
            Dim lc As New LayoutControl()
            lc.Dock = DockStyle.Fill
            Dim teLogin As New TextEdit()
            Dim tePassword As New TextEdit()
            Dim ceKeep As New CheckEdit() With {.Text = "Keep me signed in"}
            lc.AddItem(String.Empty, teLogin).TextVisible = False
            lc.AddItem(String.Empty, tePassword).TextVisible = False
            lc.AddItem(String.Empty, ceKeep)
            Me.Controls.Add(lc)
            Me.Dock = DockStyle.Fill
        End Sub
    End Class
End Namespace

Inheritance

Object

XtraDialog