Plasma.WpfUtils

Plasma.WpfUtils is a open-source librairy of reusable WPF simple mini-services.

Plasma.WpfDialogBox

Service for MVVM usage of message box and dialog box

Installing / Getting started

Simply reference the librairies into your project, or use NuGet :

Install-Package Plasma.WpfDialogBox

Usage

Basic Usage

Add a CurrentMessageBox property to your view model

public class MainViewModel : ViewModelBase
{
    private MessageBoxContainerViewModel _CurrentMessageBox;
    public MessageBoxContainerViewModel CurrentMessageBox
    {
        get
        {
            return _CurrentMessageBox;
        }
        set
        {
            Set(() => CurrentMessageBox, ref _CurrentMessageBox, value);
        }
    }
}

Suscribe to the service events and set the CurrentMessageBox for this events

MessageBoxService _Service;
public MainViewModel()
{
    var defaultMessageBoxViewModel = new GenericMessageBoxViewModel();
    _Service = new MessageBoxService(defaultMessageBoxViewModel);
 
    _Service.OnShowRequestStarted += (s, e) => CurrentMessageBox = e.ViewModel;
    _Service.OnHideRequestEnded += (s, e) => CurrentMessageBox = null;
}

Add a ContentControl to your view for displaying the message box

<Window [...]>
    <Grid>
        <ContentControl Height="Auto" 
                        Width="Auto"
                        Content="{Binding CurrentMessageBox}">
            <!--MESSAGEBOX CONTAINER-->
        </ContentControl>
    </Grid>
</Window>

Add the corresponding DataTemplate and namespaces

<Window 
	[...]
    xmlns:boxView="clr-namespace:Plasma.WpfDialogBox.Views;assembly=Plasma.WpfDialogBox"
    xmlns:boxVM="clr-namespace:Plasma.WpfDialogBox.ViewModels;assembly=Plasma.WpfDialogBox"
    [...]>
    <Window.Resources>
        <ResourceDictionary>
            <DataTemplate DataType="{x:Type boxVM:MessageBoxContainerViewModel}">
                <boxView:MessageBoxContainer></boxView:MessageBoxContainer>
            </DataTemplate>
        </ResourceDictionary>
    </Window.Resources>

In this exemple, we add a button for displaying the message box

<Button Command="{Binding YesNoMessageBoxCommand}" >Yes/No MessageBox</Button>

public RelayCommand YesNoMessageBoxCommand { get; private set; }
 
async void YesNoMessageBox()
{
    var result = await _Service.ShowMessage("This is the content of the message box", "This is the title", System.Windows.MessageBoxButton.YesNo);
    if (result == System.Windows.MessageBoxResult.Yes)
        await _Service.ShowMessage("User choose Yes !");
    if (result == System.Windows.MessageBoxResult.No)
        await _Service.ShowMessage("User choose No !");
}

Result

Custom the GenericMessageBox

You can pass your own view model, descending from GenericMessageBoxViewModel

var myMessageBoxViewModel = new MyMessageBoxViewModel();
_Service = new MessageBoxService(myMessageBoxViewModel);
// […]
public class MyMessageBoxViewModel : GenericMessageBoxViewModel
{
    // What you want
    void MyCustomAction()
	{
    	base.Hide();
	}
}

And you can make your own view as a UserControl, using this view model

<ResourceDictionary>
  	[...]
    <DataTemplate DataType="{x:Type local:MyMessageBoxViewModel}">
        <local:MyUserControl></local:MyUserControl>
    </DataTemplate>
</ResourceDictionary>

Make your own MessageBox

In the same spirit, you can make, your own view model and view, descending from BaseMessageBoxViewModel

public class MyMessageBoxViewModel : BaseMessageBoxViewModel
{
    // What you want
  	void MyCustomAction()
	{
    	base.Hide();
	}
}

Add your DataTemplate

<ResourceDictionary>
  	[...]
    <DataTemplate DataType="{x:Type local:MyCustomViewModel}">
        <local:MyUserControl></local:MyUserControl>
    </DataTemplate>
</ResourceDictionary>

And show it with the ShowCustomMessageBox method

var result = await _Service.ShowCustomMessageBox(new MyMessageBoxViewModel { /* What you want */ });

The IsModal option

With the ShowMessage method, the user can't interact with other control under the message box, because the BaseMessageBoxViewModel has a IsModal boolean property automaticly set to true for the GenericMessageBoxViewModel.

If you want to reproduce this behavior, just set IsModal to true in your CustomViewModel.

Dialog IO

Dialog IO is a simple wrapper for Microsoft.WindowsAPICodePack.Dialogs to simplify usage and facilitate the creation of unit tests.

Exemple

private readonly IDialogIOFactory _DialogIOFactory = new DialogIOFactory();

void OpenFileDialog()
{
    var openFileDialog = _DialogIOFactory.CreateOpenFileDialog(".csv", "CSV files (.csv)", "*.csv");
    if (openFileDialog.ShowDialog() != MessageBoxResult.OK)
        return;
    
    // Use openFileDialog.FileName;
    // [...]
}

void ChooseDirectoryDialog()
{
    var chooseFolerDialog = _DialogIOFactory.CreateChooseDirectoryDialog();
    if (chooseFolerDialog.ShowDialog() != MessageBoxResult.OK)
        return;
      
    // Use chooseFolerDialog.DirectoryName;
    // [...]
}

To Do

• Make the GenericMessageBox usable with multiple languages.
• Add a parameter for allow to displaying the view into a real windows, instead of a WPF "popin".
• Allow to superpose message box (by exemple, an action in a message box that open a other message box)

Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome.

Licensing

The code in this project is licensed under GNU GPL license.