UICommand Class

A ViewModel that is used to generate a dialog button.

Namespace: DevExpress.Mvvm

Assembly: DevExpress.Mvvm.v22.1.dll

Declaration

C#

public class UICommand :
    BindableBase,
    IUICommand

VB.NET

Public Class UICommand
    Inherits BindableBase
    Implements IUICommand

Related API Members

The following members return UICommand objects:

Library	Related API Members
Cross-Platform Class Library	IDialogService.ShowDialog(IEnumerable<UICommand>, String, String, Object, Object, Object)
WPF Controls	DXDialogWindow.ShowDialogWindow()
	ThemedMessageBox.Show(IEnumerable<UICommand>, Window, String, UIElement, ImageSource, MessageBoxOptions, WindowStartupLocation, WindowTitleAlignment, Nullable<Boolean>)
	ThemedMessageBox.Show(IEnumerable<UICommand>, Window, String, UIElement, MessageBoxImage, Boolean, MessageBoxOptions, WindowStartupLocation, WindowTitleAlignment, Nullable<Boolean>)
	ThemedMessageBox.Show(String, IEnumerable<UICommand>, Window, String, ImageSource, MessageBoxOptions, WindowStartupLocation, WindowTitleAlignment, Nullable<Boolean>)
	ThemedMessageBox.Show(String, IEnumerable<UICommand>, Window, String, MessageBoxImage, Boolean, MessageBoxOptions, WindowStartupLocation, WindowTitleAlignment, Nullable<Boolean>)
	ThemedWindow.DialogButtonCommandResult
	ThemedWindow.ShowDialog(IEnumerable<UICommand>)
	ThemedWindowDialogButton.UICommand

Remarks

The code sample below shows how to define dialog buttons:

C#

UICommand registerCommand = new UICommand(
    id: null,
    caption: "Register",
    command: new DelegateCommand<CancelEventArgs>(
        cancelArgs => {
            try {
                myExecuteMethod();
            }
            catch (Exception e) {
                this.GetService<IMessageBoxService>().ShowMessage(e.Message, "Error", MessageButton.OK);
                cancelArgs.Cancel = true;
            }
        },
        cancelArgs => !string.IsNullOrEmpty(registrationViewModel.UserName)
    ),
    isDefault: true,
    isCancel: false
);

UICommand cancelCommand = new UICommand(
    id: MessageBoxResult.Cancel,
    caption: "Cancel",
    command: null,
    isDefault: false,
    isCancel: true
);

IDialogService service = this.GetService<IDialogService>(serviceName);
UICommand result = service.ShowDialog(
    dialogCommands: new[] { registerCommand, cancelCommand },
    title: "Registration Dialog",
    viewModel: detailViewModel
);

VB.NET

Dim registerCommand As UICommand = New UICommand(
    id:=Nothing, 
    caption:="Register", 
    command:=New DelegateCommand(Of CancelEventArgs)(
        Function(cancelArgs)
            Try
                myExecuteMethod()
            Catch e As Exception
                Me.GetService(Of IMessageBoxService)().ShowMessage(e.Message, "Error", MessageButton.OK)
                cancelArgs.Cancel = True
            End Try
        End Function, 
        Function(cancelArgs) 
            Not String.IsNullOrEmpty(registrationViewModel.UserName)), isDefault:=True, isCancel:=False)

Dim cancelCommand As UICommand = New UICommand(
    id:=MessageBoxResult.Cancel, 
    caption:="Cancel", 
    command:=Nothing, 
    isDefault:=False, 
    isCancel:=True)

Dim service As IDialogService = Me.GetService(Of IDialogService)(serviceName)

Dim result As UICommand = 
    service.ShowDialog(
        dialogCommands:={registerCommand, cancelCommand}, 
        title:="Registration Dialog", 
        viewModel:=detailViewModel)

View Example: How to: Use DialogService

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the UICommand class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

how-to-use-dialogservice-and-dxmessageboxservice-e4859/VB/MessageBoxServiceCodeExample/ViewModel/DialogViewModel.vb#L31

Private privateDialogCommands As List(Of UICommand)
Public Property DialogCommands() As List(Of UICommand)

Reporting_wpf-end-user-report-designer-how-to-create-a-custom-data-source-wizard-t286514/VB/Custom Wizard/WizardDataModel.vb#L85

Dim dataErrorInfo As IDataErrorInfo = dsw
Dim okCommand As UICommand = New UICommand With {.Caption = "OK", .IsCancel = False, .IsDefault = True, .Command = New DelegateCommand(Of CancelEventArgs)(Sub(x As CancelEventArgs)
    End Sub, Function(x As CancelEventArgs) String.IsNullOrEmpty(dataErrorInfo.Error))}

How-to-return-the-DialogResult-when-using-CommandsSource/VB/MyDialogViewModel.vb#L13

    Property DialogTitle() As String
    Property CommandsSource() As IEnumerable(Of UICommand)
End Interface

How-to-validate-appointment-items-on-adding-or-editing-them-in-SchedulerControl/VB/DXSample/ValidationClasses/SchedulerValidationService.vb#L23

If toCancel.Count > 0 Then
    Dim Cancel = New UICommand() With {
        .Caption = "Cancel",

lookupedit-processing-new-values-e2646/VB/HowToCreateLookUpEdit/ViewModel/ProductList.vb#L60

Dim p As New Product() With {.ProductName = parameter}
Dim addProductCommand As New UICommand() With {.Caption = "Add", .IsCancel = False, .IsDefault = True}

C#

Reporting_wpf-end-user-report-designer-how-to-create-a-custom-data-source-wizard-t286514/CS/Custom Wizard/WizardDataModel.cs#L77

IDataErrorInfo dataErrorInfo = dsw;
UICommand okCommand = new UICommand {
    Caption = "OK",

How-to-return-the-DialogResult-when-using-CommandsSource/CS/MyDialogViewModel.cs#L15

    string DialogTitle { get; set; }
    IEnumerable<UICommand> CommandsSource { get; set; }
}

lookupedit-processing-new-values-e2646/CS/HowToCreateLookUpEdit/ViewModel/ProductList.cs#L46

Product p = new Product() { ProductName = parameter };
UICommand addProductCommand = new UICommand() {
    Caption = "Add",

how-to-use-dialogservice-t145641/CS/ViewModel/MainViewModel.cs#L21

public void ShowRegistrationForm() {
    UICommand registerCommand = new UICommand(
        id: null,

how-to-navigate-through-views-by-using-navbarcontrol-control-and-navigationframe-class-e5129/CS/ViewModel/MainViewModel.cs#L16

UICommand registerCommand = new UICommand() {
    Caption = "Register",

Inheritance

Object

BindableBase

UICommand