DSoft.System.Mvvm.Ui 3.0.2110.41-prerelease

This is a prerelease version of DSoft.System.Mvvm.Ui.
There is a newer prerelease version of this package available.
See the version list below for details.
Install-Package DSoft.System.Mvvm.Ui -Version 3.0.2110.41-prerelease
dotnet add package DSoft.System.Mvvm.Ui --version 3.0.2110.41-prerelease
<PackageReference Include="DSoft.System.Mvvm.Ui" Version="3.0.2110.41-prerelease" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DSoft.System.Mvvm.Ui --version 3.0.2110.41-prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DSoft.System.Mvvm.Ui, 3.0.2110.41-prerelease"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install DSoft.System.Mvvm.Ui as a Cake Addin
#addin nuget:?package=DSoft.System.Mvvm.Ui&version=3.0.2110.41-prerelease&prerelease

// Install DSoft.System.Mvvm.Ui as a Cake Tool
#tool nuget:?package=DSoft.System.Mvvm.Ui&version=3.0.2110.41-prerelease&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

System.Mvvm

Model View View Model (MVVM) classes with built in Dependency Injection (DI) for all variants of .NET.

Also provides centralised multi-platform UI Management for WPF (.NET Framework, .NET Core 3.1 and .NET 5.x) and WinUI 3 (Preview 4 and above)(Experimental)

Functionality

  • Implements INotifyPropertyChanged
  • Implements INotifyDataErrorInfo
  • Events for handling and detecting changes
  • Additional properties for
    • IsLoaded
    • IsBusy
    • IsBusyReveresed
    • IsValid
    • IsEditable
    • IsEditableReversed
  • Data Validation
  • Built-In Error notification methods
  • ICommand binding helpers
  • Notification extension actions
    • Rather than overriding a property, add an action when it changes
  • Base View Models for
    • Forms
    • Lists
    • Searchable Lists
    • Tree View Searchable Lists
  • UI
    • Core UI functions for Showing Alerts and Confirmation Dialogs (using platform specific implementations)
      • UWP, WinUI and WPF (.NET Framework and .NET Core 3.1, .NET 5+)

Classes

ViewModel

This is the base View Model abstract class which contains the most common MVVM functionality

ListViewModel<T,T2>

This class inherits from ViewModel and provides additonal functionality for managing lists of data

SearchViewModel<T, T2>

This class inherits from ListViewModel<T,T2> and adds search and filtering functionality to the standard ListViewModel

SearchTreeViewModel<T, T2>

This class inherits from SearchViewModel<T, List<T>> and adds Tree Path preparation to the standard SearchViewModel

Using System.Mvvm

Basic ViewModel

All of the ViewModel base classess are in the System.Mvvm namespace. To create a basic ViewModel simple inherit from ViewModel.

using System.Mvvm;
...
public class MainViewModel : ViewModel
{

To create a notifiable property create a property with a backing field using the propfull snippet and add a call to NotifyPropertyChanged.

private int myVar;

public int MyProperty
{
    get { return myVar; }
    set { myVar = value;  NotifyPropertyChanged();}
}

NotifyPropertyChanged will automatically pickup the calling member, but you can also be explicit.

private int myVar;

public int MyProperty
{
    get { return myVar; }
    set { myVar = value; NotifyPropertyChanged(nameof(MyProperty)); }
}

Using System.Mvvm.Ui

The UI static class provides two features

  • A central interface for calling some simple UI functions
    • ShowAlert(string title, string message)
      • Show an alert with a title and message
    • ShowConfirmation(string title, string message)
      • Show a confirmation dialog and return the result
    • InvokeOnUIThread(Action)
      • Execute the action on the UI thread
    • InvokeOnUIThreadAsync(Action)
      • Execute the action on the UI thread asyncronously

The standard UI functions can be called directly after adding the DSoft.Mvvm.Ui package

using System.Mvvm;
... 

var result = await UI.ShowConfirmationDialogAsync("Confirm this", "This is a platform specific confirmation message");

if (result)
    await UI.ShowAlertAsync("YAY!", "You confirmed that");

NOTE: The standard UI functions only work when the platform code has been registered using MvvmManager.Init on the supported plaforms

MvvmManager

MvvmManager is a class that is found in the Dsoft.System.Mvvm.Ui package and registers the standard UI implementation for UI for each supported platform.

Call MvvmManager.Initto initialise the platform implementation.

NOTE: Only WPF(.NET framework, .NET Core 3.1, .NET 5.x) and WinUI 3 (Preview 4 and above) and UWP are supported with MvvmManager at the moment

NuGet packages (3)

Showing the top 3 NuGet packages that depend on DSoft.System.Mvvm.Ui:

Package Downloads
DSoft.System.Mvvm.UI.Forms

Xamarin.Forms platform support for System.Mvvm.UI

DSoft.System.Mvvm.UI.WPF

WPF platform support for DSoft.System.Mvvm.UI for .NET Framework, .NET Core 3.1 and NET5+

DSoft.System.Mvvm.UI.WinUI

UWP and WinUI 3 platform support for System.Mvvm.UI for NET5+ and UWP

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.2111.271-prerelease 48 11/27/2021
3.0.2110.81-prerelease 115 10/8/2021
3.0.2110.71-prerelease 86 10/7/2021
3.0.2110.61-prerelease 75 10/6/2021
3.0.2110.41-prerelease 104 10/4/2021
2.4.2109.301 168 9/30/2021
2.4.2108.41 154 8/5/2021
2.3.2107.201 80 7/20/2021
2.3.2105.221 131 5/24/2021
2.3.2105.211-preview2 82 5/21/2021
2.2.2103.241-preview2 127 3/24/2021
2.2.2102.142-prerelease 67 2/14/2021
2.2.2102.141-preview1 68 2/14/2021
2.1.2103.242-preview2 94 3/24/2021
2.1.2102.81 211 2/8/2021
2.0.2011.103 276 11/10/2020
1.3.2010.162-prerelease 142 10/16/2020
1.3.2010.151-prerelease 156 10/15/2020
1.2.2010.151 193 10/15/2020
1.2.2010.121 190 10/12/2020
1.2.2006.221 344 6/22/2020
1.2.2005.121 201 5/12/2020
1.2.2004.202 227 4/20/2020
1.2.2004.91 250 4/9/2020
1.2.2002.171 307 2/17/2020
1.2.1911.261 352 11/26/2019
1.2.1911.212 234 11/21/2019

- Added Host IServiceCollection extensions