Skip to main content

Showing a message box from a ViewModel in MVVM

I was doing a code review with a client last week for a WPF app using MVVM and they asked 'How can I show a message from the ViewModel?'. What follows is how I would (and have) solved the problem in the past.

When I hear the words 'show a message...' I instantly think you mean show a transient modal message box that requires the user input before continuing 'with something else' - once the user has interacted with the message box it will disappear. The following solution only applies to this scenario.

The first solution is the easiest but is very wrong from a separation perspective. It violates the ideas behind the Model-View-Controller pattern because it places View concerns inside the ViewModel - the ViewModel now knows about the type of the View and specifically it knows how to show a message box window:
The second approach addresses this concern by introducing the idea of messaging\events between the ViewModel and the View. In the example below I'm using the implementation MVVMLight framework Messenger instance to pass the message body from the ViewModel to the View. There is more of a ceremony to the code but we do get the separation between the View and the ViewModel.

The View for the second approach is shown below, as you can see we are accessing the ViewModel directly from the View via the DataContext property. I don't have any trouble with the View knowing about the ViewModel just the ViewModel knowing about the View. I could improve this separation by adding a dependency property to the View for the Messenger - then there wouldn't be an explicit use of the ViewModel in the code-behind of the View:
The ViewModel now looks like this:
Why is this still wrong?


We've managed to de-couple the ViewModel from the technology used to show a message box in the View, but we are still defining WHAT is going to be displayed by the View from the ViewModel - 'Need Help' & 'Do you want to do the work?'

This problem would become very apparent if this was a multilingual app, this method would require the ViewModel to manage the display resources (text) via a cultural specific resource (*.resx) class - this is not the correct place to do this, it should be done by the View.

The third solution is my preferred way, send a message with context to allow the View to show a message to the user, where the View decides upon what & how will be shown'

This give the following View, you can see now the View is deciding what is going to be shown:
And the ViewModel now looks like this:

There is more of a ceremony to the code but I do believe this gives the separation required of the View & ViewModel.








Comments

  1. Hi,

    Nice article! Thanks.

    An even simpler way that preserves separation of concerns is to have the View deposit the address of one of its Message Display Methods into an appropriate Action property in the ViewModel. This works about the same as your last example, but without all the ceremony of messages. Long live the Action!

    George Stevens

    ReplyDelete
    Replies
    1. nice idea, think I'll give that a try...

      Delete
    2. I just published an article in my blog about using the Action like that. Its at http://dotnetsilverlightprism.wordpress.com/

      Delete
    3. I recently evolved from using events/delegates in my VM -> V communication, to using Actions.

      I pass the action in to the VM, store it in a member var until some asynch operation returns. Then I schedule the action on the UI thread, and set it to null in the VM. It works wonders, and produces awesome flow of code, very much like the async await pattern of Windows 8.

      Delete
    4. Have you got a sample of this code anywhere? What is Imessenger implemented?

      Delete

Post a comment

Popular posts from this blog

WPF tips & tricks: Dispatcher thread performance

Not blogged for an age, and I received an email last week which provoked me back to life. It was a job spec for a WPF contract where they want help sorting out the performance of their app especially around grids and tabular data. I thought I'd shared some tips & tricks I've picked up along the way, these aren't probably going to solve any issues you might be having directly, but they might point you in the right direction when trying to find and resolve performance issues with a WPF app. First off, performance is something you shouldn't try and improve without evidence, and this means having evidence proving you've improved the performance - before & after metrics for example. Without this you're basically pissing into the wind, which can be fun from a developer point of view but bad for a project :) So, what do I mean by ' Dispatcher thread performance '? The 'dispatcher thread' or the 'UI thread' is probably the most

Implementing a busy indicator using a visual overlay in MVVM

This is a technique we use at work to lock the UI whilst some long running process is happening - preventing the user clicking on stuff whilst it's retrieving or rendering data. Now we could have done this by launching a child dialog window but that feels rather out of date and clumsy, we wanted a more modern pattern similar to the way <div> overlays are done on the web. Imagine we have the following simple WPF app and when 'Click' is pressed a busy waiting overlay is shown for the duration entered into the text box. What I'm interested in here is not the actual UI element of the busy indicator but how I go about getting this to show & hide from when using MVVM. The actual UI elements are the standard Busy Indicator coming from the WPF Toolkit : The XAML behind this window is very simple, the important part is the ViewHost. As you can see the ViewHost uses a ContentPresenter element which is bound to the view model, IMainViewModel, it contains 3 child v