(7/7).net core 3 wpf mvvm框架 prism系列之對話框服務

(7/7).net core 3 wpf mvvm框架 prism系列之對話框服務

如何在.net core3環境下使用mvvm框架prism的對話框服務，這也是prism系列的最後一篇完結文章

最后更新 2023/6/11 上午12:47
RyzenAdorer
预计阅读 7 分钟
分类
WPF
专题
wpf mvvm框架 prism系列
标签
.NET C# WPF Prism MVVM

本文來自轉載

原文作者：ryzenadorer

原文標題：.net core 3 wpf mvvm 框架 prism 系列之對話框服務

原文連結：https://www.cnblogs.com/ryzen/p/12771986.html

本文將居間如何在.net core3 環境下使用 mvvm 框架 prism 的對話框服務，這也是 prism 系列的最後一篇完結文章，下面是 prism 系列文章的索引：

.NET Core 3 WPF MVVM 框架 Prism 系列之文章索引

1. 對話框服務

在 prism 中，通過一個 idialogaware 接口來實現對話框服務：

public interface IDialogAware
{
    bool CanCloseDialog();
    void OnDialogClosed();
    void OnDialogOpened(IDialogParameters parameters);
    string Title { get; set; }
    event Action<IDialogResult> RequestClose;
}
  • canclosedialog()函數是決定窗體是否關閉
  • ondialogclosed()函數是窗體關閉時觸發，觸發條件取決於 canclosedialog()函數
  • ondialogopened()函數時窗體打開時觸發，比窗體 loaded 事件早觸發
  • title 為窗體的標題
  • requestclose 為關閉事件，可由此控制窗體的關閉

2.1.創建對話框的 view 和 viewmodel

AlertDialog.xaml：

<UserControl
  x:Class="PrismMetroSample.Shell.Views.Dialogs.AlertDialog"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
  xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
  xmlns:local="clr-namespace:PrismMetroSample.Shell.Views.Dialogs"
  mc:Ignorable="d"
  xmlns:prism="http://prismlibrary.com/"
  Width="350"
  Height="120"
  prism:ViewModelLocator.AutoWireViewModel="True"
>
  <Grid Margin="5">
    <Grid.RowDefinitions>
      <RowDefinition />
      <RowDefinition Height="Auto" />
    </Grid.RowDefinitions>
    <Grid Margin="0,0,0,10">
      <Grid.ColumnDefinitions>
        <ColumnDefinition Width="70" />
        <ColumnDefinition />
      </Grid.ColumnDefinitions>
      <image
        Source="pack://application:,,,/PrismMetroSample.Infrastructure;Component/Assets/Photos/alter.png"
        Height="40"
        UseLayoutRounding="True"
        RenderOptions.BitmapScalingMode="HighQuality"
      />
      <TextBlock
        Grid.Column="1"
        Text="{Binding Message}"
        HorizontalAlignment="Left"
        VerticalAlignment="Center"
        Grid.Row="0"
        TextWrapping="Wrap"
        FontSize="15"
        FontFamily="Open Sans"
      />
    </Grid>
    <Grid Grid.Row="1">
      <Grid.ColumnDefinitions>
        <ColumnDefinition />
        <ColumnDefinition />
      </Grid.ColumnDefinitions>
      <button
        Margin="5"
        Foreground="White"
        FontSize="12"
        Background="#5cb85c"
        Command="{Binding CloseDialogCommand}"
        CommandParameter="true"
        Content="Yes"
        Width="64"
        Height="28"
        HorizontalAlignment="Right"
        Grid.Row="1"
      />
      <button
        Grid.Column="1"
        Margin="5"
        Foreground="White"
        FontSize="12"
        Background="#d9534f"
        Command="{Binding CloseDialogCommand}"
        CommandParameter="false"
        Content="No"
        Width="64"
        Height="28"
        HorizontalAlignment="Left"
        Grid.Row="1"
      />
    </Grid>
  </Grid>
</UserControl>

AlertDialogViewModel.cs：

public class AlertDialogViewModel : BindableBase, IDialogAware
{
    private DelegateCommand<string> _closeDialogCommand;
    public DelegateCommand<string> CloseDialogCommand =>
        _closeDialogCommand ?? (_closeDialogCommand = new DelegateCommand<string>(ExecuteCloseDialogCommand));

    void ExecuteCloseDialogCommand(string parameter)
    {
        ButtonResult result = ButtonResult.None;
        if (parameter?.ToLower() == "true")
            result = ButtonResult.Yes;
        else if (parameter?.ToLower() == "false")
            result = ButtonResult.No;
         RaiseRequestClose(new DialogResult(result));
     }

     //触发窗体关闭事件
     public virtual void RaiseRequestClose(IDialogResult dialogResult)
     {
         RequestClose?.Invoke(dialogResult);
     }

     private string _message;
     public string Message
     {
         get { return _message; }
         set { SetProperty(ref _message, value); }
     }

     private string _title = "Notification";
     public string Title
     {
         get { return _title; }
         set { SetProperty(ref _title, value); }
     }

     public event Action<IDialogResult> RequestClose;

     public bool CanCloseDialog()
     {
         return true;
     }

     public void OnDialogClosed()
     {

     }

     public void OnDialogOpened(IDialogParameters parameters)
     {
         Message = parameters.GetValue<string>("message");
     }
 }

2.2.註冊對話框

App.cs：

protected override void RegisterTypes(IContainerRegistry containerRegistry)
{
     containerRegistry.RegisterDialog<AlertDialog, AlertDialogViewModel>();
}
还可以注册时起名字：

Copy
containerRegistry.RegisterDialog<AlertDialog, AlertDialogViewModel>(“alertDialog”);

2.3.使用對話框服務

createaccountviewmodel.cs(修改部分)：

public CreateAccountViewModel(IRegionManager regionManager, IDialogService dialogService)
{
     _regionManager = regionManager;
     _dialogService = dialogService;
}

 public void ConfirmNavigationRequest(NavigationContext navigationContext, Action<bool> continuationCallback)
 {
     if (!string.IsNullOrEmpty(RegisteredLoginId) && this.IsUseRequest)
     {
          _dialogService.ShowDialog("AlertDialog", new DialogParameters($"message={"是否需要用当前注册的用户登录?"}"), r =>
           {
                 if (r.Result == ButtonResult.Yes)
                     navigationContext.Parameters.Add("loginId", RegisteredLoginId);
           });
      }
      continuationCallback(true);

 }

效果如下：

我們是通過調用 idialogservice 接口的 showdialog 函數來調用，下面是該接口的定義：

public interface IDialogService : Object
{
    Void Show(String name, IDialogParameters parameters, Action<IDialogResult> callback);
    Void ShowDialog(String name, IDialogParameters parameters, Action<IDialogResult> callback);

 }

我們可以發現 show 和 showdialog 函數都是一樣形參，無非就是使用場景不一樣

  • name：所要調用對話框 view 的名字，當註冊別名時，只能使用別名來調用
  • parameters：idialogparameters 接口類型參數,傳入的提示消息，通常是$"message="格式，然後再 viewmodel 的 ondialogopened 函數通過 idialogparameters 接口的 getvalue 函數來獲取
  • callback：用於傳入無返回值回調函數

2. 自定義對話框窗體

我們在上述可以看到，對話框的窗體時一個 wpf 自帶的窗體，但是當我們要用自己自定義窗體，例如，去掉 window 的 icon，保留最大化，最小化和關閉，或者使用一些第三方的窗體控制項，prism 支持通過註冊一個對話框窗體，然後通過再不同對話框的 view 指定其對話框窗體的 style，則可以很靈活的實現不一樣的對話框，下面讓我們來看看如何操作：

2.1.註冊自定義對話框窗體

新建一個窗體，dialogwindow.xaml：

<Window
  x:Class="PrismMetroSample.Shell.Views.Dialogs.DialogWindow"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
  xmlns:local="clr-namespace:PrismMetroSample.Shell.Views.Dialogs"
  mc:Ignorable="d"
  xmlns:prism="http://prismlibrary.com/"
>
  <Grid> </Grid>
</Window>

DialogWindow.xaml.cs：

public partial class DialogWindow : Window, IDialogWindow
{
    public DialogWindow()
    {
        InitializeComponent();
    }

    protected override void OnSourceInitialized(EventArgs e)
    {
        WindowHelp.RemoveIcon(this);//使用win32函数去除Window的Icon部分
    }

    public IDialogResult Result { get; set; }
}

App.cs：

protected override void RegisterTypes(IContainerRegistry containerRegistry)
{
     containerRegistry.RegisterDialogWindow<DialogWindow>();//注册自定义对话框窗体
}

2.2.自定義對話框窗體 style

AlertDialog.xaml:

<prism:Dialog.WindowStyle>
  <style TargetType="Window">
    <Setter Property="prism:Dialog.WindowStartupLocation" Value="CenterScreen" />
    <Setter Property="ShowInTaskbar" Value="False"/>
    <Setter Property="SizeToContent" Value="WidthAndHeight"/>
  </style>
</prism:Dialog.WindowStyle>

效果如下:

如何我們要將窗體樣式全部去掉，改動 alertdialog.xaml:

<prism:Dialog.WindowStyle>
  <style TargetType="Window">
    <Setter Property="prism:Dialog.WindowStartupLocation" Value="CenterScreen" />
    <Setter Property="ShowInTaskbar" Value="False"/>
    <Setter Property="SizeToContent" Value="WidthAndHeight"/>
    <Setter Property="WindowStyle" Value="None"/>
  </style>
</prism:Dialog.WindowStyle>

那麼就變成了下面這樣：

最終，我們的最後效果為這樣：

3. 小結

通過 prism 的對話框服務，我們可以很好的通過一個 idialogservice 接口來統一管理對話框的彈出邏輯，而且可以使用依賴注入的模式，如果換成之前要定義一些自定義的對話框，那麼也要強依賴 view 部分，而且可以通過自定義不同對話框的窗體樣式，達到一定的靈活性(例如最終效果演示，用了兩個不同的對話框樣式)，至此, .net core3.x prism 系列文章已經全部寫完

4. 源碼

最后，附上整个 demo 的源代码：PrismDemo 源码

Keep Exploring

延伸阅读

更多文章
友情链接
林德熙 YouZack WTM NuGet Next 可樂不加冰 加菲的博客 Furion 懶得勤快 迷戀自留地 52ABP dotnet全棧開發 程式設計實驗室 江湖人士 King-AbpVnext-Pro