Skip to main content

An Asynchronous Delegate Command for your WPF MVVM Apps - AsyncDelegateCommand

image This post assumes you are familiar with basic MVVM concepts and RelayCommand/DelegateCommand

In a lot of scenarios, you need to perform operations in an asynchronous way in your View Model. And most of the time, BackgroundWorker class comes handy. So, here is a quick implementation of an Asynchronous version of DelegateCommand, that wraps the BackgroundWorker under the hoods.

    /// <summary>
    /// An async version for delegate command
    /// </summary>
    public class AsyncDelegateCommand : ICommand 
    {

        BackgroundWorker _worker=new BackgroundWorker();
        Func<bool> _canExecute;

        /// <summary>
        /// The constructor
        /// </summary>
        /// <param name="action">The action to be executed</param>
        /// <param name="canExecute">Will be used to determine if the action can be executed</param>
        /// <param name="completed">Will be invoked when the action is completed</param>
        /// <param name="error">Will be invoked if the action throws an error</param>
        public AsyncDelegateCommand(Action action, 
                                    Func<bool> canExecute=null,
                                    Action<object> completed =null,
                                    Action<Exception> error=null
                                    )
        {

            _worker.DoWork += (s, e) =>
                {
                    CommandManager.InvalidateRequerySuggested();
                    action();
                };

            _worker.RunWorkerCompleted += (s, e) =>
                {

                    if (completed != null && e.Error == null)
                        completed(e.Result);

                    if (error != null && e.Error != null)
                        error(e.Error);

                    CommandManager.InvalidateRequerySuggested();
                };

            _canExecute = canExecute;
        }


        /// <summary>
        /// To cancel an ongoing execution
        /// </summary>
        public void Cancel()
        {
            if (_worker.IsBusy)
                _worker.CancelAsync(); 
        }

        /// <summary>
        /// Note that this will return false if the worker is already busy
        /// </summary>
        /// <param name="parameter"></param>
        /// <returns></returns>
        public bool CanExecute(object parameter)
        {
            return (_canExecute == null) ? 
                    !(_worker.IsBusy) : !(_worker.IsBusy) 
                        && _canExecute();    
        }

        /// <summary>
        /// Let us use command manager for thread safety
        /// </summary>
        public event EventHandler CanExecuteChanged
        {
            add { CommandManager.RequerySuggested += value; }
            remove { CommandManager.RequerySuggested -= value; }
        }

        /// <summary>
        /// Here we'll invoke the background worker
        /// </summary>
        /// <param name="parameter"></param>
        public void Execute(object parameter)
        {
            _worker.RunWorkerAsync(); 
        }
    }
So, now from your view model, you can use use our AsyncDelegateCommand like this.
    public class YourViewModel : INotifyPropertyChanged
    {
        public YourViewModel()
        {
            DoSomethingCommand = new AsyncDelegateCommand(
                    action:() => DoSomething(),                   
                    error:(ex)=>Debug.WriteLine(ex.Message));
        }

        public ICommand DoSomethingCommand { get; set; }

        void DoSomething()
        { 
        }
		
    }

This will execute DoSomething in an asynchronous manner. And when you bind the DoSomethingCommand to the Command property of your UI elements, you'll see that the UI element's enable/disable state is changing automatically based on our BackgroundWorker's state (i.e, when worker is busy, you'll see your buttons disabled).

Just thought about sharing the implementation after finding this pretty handy :). Not sure if some one out there already has a similar idea/implementation that wraps the Background worker inside a command implementation, if you know about any, please leave a message. A quick note – I’m using optional parameters here (C# 4.0 specific). So tailor down as required if you need to use this in 3.5.

Happy Coding!!

Popular posts from this blog

Top 7 Coding Standards & Guideline Documents For C#/.NET Developers

Some time back, I collated a list of 7 Must Read, Free EBooks for .NET Developers, and a lot of people found it useful. So, I thought about putting together a list of Coding Standard guidelines/checklists for .NET /C# developers as well.As you may already know, it is easy to come up with a document - the key is in implementing these standards in your organization, through methods like internal trainings, Peer Reviews, Check in policies, Automated code review tools etc. You can have a look at FxCop and/or StyleCop for automating the review process to some extent, and can customize the rules based on your requirements.Anyway, here is a list of some good Coding Standard Documents. They are useful not just from a review perspective - going through these documents can definitely help you and me to iron out few hidden glitches we might have in the programming portion of our brain. So, here we go, the listing is not in any specific order.1 – IDesign C# Coding StandardsIDesign C# coding stand…

Creating a quick Todo listing app on Windows using IIS7, Node.js and Mongodb

As I mentioned in my last post, more and more organizations are leaning towards Web Oriented Architecture (WOA) which are highly scalable. If you were exploring cool, scalable options to build highly performing web applications, you know what Node.js is for.After following the recent post from Scott Hanselman, I was up and running quickly with Node.js. In this post, I’ll explain step by step how I’ve setup Node.js and Mongodb to create a simple Todo listing application.Setting up Node.jsThis is what I’ve done.1 – Goto http://nodejs.org/, scroll down and download node.exe for Windows, and place it in your c:\node folder2 – Goto IIS Node project in Git at https://github.com/tjanczuk/iisnode, download the correct ‘retail’ link of IIS Node zip file (I downloaded the already built retail package, otherwise you can download and build from the source).3 – Extract the zip file some where, and run the install.bat or install_iisexpress.bat depending on your IIS Version. If you don’t have IIS in…

MVVM - Binding Multiple Radio Buttons To a single Enum Property in WPF

I had a property in my View Model, of an Enum type, and wanted to bind multiple radio buttons to this.

Firstly, I wrote a simple Enum to Bool converter, like this.

public class EnumToBoolConverter : IValueConverter { #region IValueConverter Members public object Convert(object value, Type targetType, object parameter, System.Globalization.CultureInfo culture) { if (parameter.Equals(value)) return true; else return false; } public object ConvertBack(object value, Type targetType, object parameter, System.Globalization.CultureInfo culture) { return parameter; } #endregion }

And my enumeration is like

public enum CompanyTypes { Type1Comp, Type2Comp, Type3Comp } Now, in my XAML, I provided the enumeration as the ConverterParameter, of the Converter we wrote earlier, like
<Wi…