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…

Hack Raspberry Pi – How To Build Apps In C#, WinForms and ASP.NET Using Mono In Pi

Recently I was doing a bit of R&D related to finding a viable, low cost platform for client nodes. Obviously, I came across Raspberry Pi, and found the same extremely interesting. Now, the missing piece of the puzzle was how to get going using C# and .NET in the Pi. C# is a great language, and there are a lot of C# developers out there in the wild who are interested in the Pi.In this article, I’ll just document my findings so far, and will explain how develop using C# leveraging Mono in a Raspberry Pi. Also, we’ll see how to write few minimal Windows Forms & ASP.NET applications in the Pie as well.Step 1: What is Raspberry Pi?Raspberry Pi is an ARM/Linux box for just ~ $30. It was introduced with a vision to teach basic computer science in schools. How ever, it got a lot of attention from hackers all around the world, as it is an awesome low cost platform to hack and experiment cool ideas as Pi is almost a full fledged computer.  More About R-Pi From Wikipedia.The Raspberry Pi

5 Awesome Learning Resources For Programmers (To help you and your kids to grow the geek neurons)

Happy New Year, this is my first post in 2012. I’ll be sharing few awesome learning resources I’ve bookmarked, and will be pointing out some specific computer/programming related courses I've found interesting from these resources.Also, thought about saving this blog post for my kids as well - instead of investing in these Child education schemes (though they are too small as of today, 2 years and 60 days respectively ). Anyway, personally my new year resolution is to see as much videos from this course collections (assuming I can find some free time in between my regular job && changing my babies diapers).1 – Khan AcademyAs I mentioned some time back, you and your kids are missing some thing huge if you havn’t heard about Khan Academy.  It is an awesome learning resource, especially if you want to re-visit your basics in Math, Science etc.With a library of over 2,600 videos covering everything from arithmetic to physics, finance, and history and 268 practice exercises, th…