初始化用户控件时显示忙碌指示器(WPF + Mvvm + DataTemplate Application)

本文关键字:WPF Mvvm DataTemplate Application 指示器 控件 用户 显示 初始化 | 更新日期: 2023-09-27 18:36:39

现状

我使用以下方法来解析匹配视图模型的视图。(简体)

<Window.Resources>
    <ResourceDictionary>
        <DataTemplate DataType="{x:Type local:DemoVm2}">
            <local:DemoViewTwo />
        </DataTemplate>
        <DataTemplate DataType="{x:Type local:DemoVm}">
            <local:DemoView />
        </DataTemplate>
    </ResourceDictionary>
</Window.Resources>
<DockPanel LastChildFill="True">
    <Button Content="Switch To VmOne" Click="ButtonBase_OnClick"></Button>
    <Button Content="Switch To VmTwo" Click="ButtonBase_OnClick2"></Button>
    <ContentPresenter Content="{Binding CurrentContent}" />
</DockPanel>

内容演示器中切换视图模型后,WPF 会自动解析视图。

当使用可能需要 2-4 秒进行初始化的复杂视图时,我想显示一个 BusyIndicator。它们最多需要 2-4 秒,因为视觉对象的数量而不是数据。

问题

我不知道视图何时完成初始化/加载过程,因为我只能访问当前的视图模型。

我的方法

我的想法是将一个行为附加到每个UserControl,该行为可以在InitializeComponent()完成或处理其LoadedEvent后为其附加的ViewModel(IsBusy=false)设置布尔值。此属性可以绑定到其他位置的繁忙指示器。

我对这个解决方案不太满意,因为我需要将此行为附加到每个单独的用户控件/视图。

没有人对这种问题有其他解决方案?我想我不是唯一一个想向用户隐藏 GUI 加载过程的人?!

我最近遇到了这个线程 http://blogs.msdn.com/b/dwayneneed/archive/2007/04/26/multithreaded-ui-hostvisual.aspx.但是由于这是从2007年开始的,因此可能会有一些更好/更方便的方法来实现我的目标?

初始化用户控件时显示忙碌指示器(WPF + Mvvm + DataTemplate Application)

这个问题没有简单和通用的解决方案。在每个具体情况下,您应该为非阻塞可视化树初始化编写自定义逻辑。

下面是如何使用初始化指示器实现 ListView 的非阻塞初始化的示例。

包含列表视图和初始化指示器的用户控件:

XAML:

<UserControl x:Class="WpfApplication1.AsyncListUserControl"
             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:WpfApplication1"
             mc:Ignorable="d" 
             d:DesignHeight="300" d:DesignWidth="300">
    <Grid Margin="5" Grid.Row="1">
        <ListView x:Name="listView"/>
        <Label x:Name="itemsLoadingIndicator" Visibility="Collapsed" Background="Red" HorizontalAlignment="Center" VerticalAlignment="Center">Loading...</Label>
    </Grid>
</UserControl>

.CS:

public partial class AsyncListUserControl : UserControl
{
    public static DependencyProperty ItemsProperty = DependencyProperty.Register("Items", typeof(IEnumerable), typeof(AsyncListUserControl), new PropertyMetadata(null, OnItemsChanged));
    private static void OnItemsChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        AsyncListUserControl control = d as AsyncListUserControl;
        control.InitializeItemsAsync(e.NewValue as IEnumerable);
    }
    private CancellationTokenSource _itemsLoadiog = new CancellationTokenSource();
    private readonly object _itemsLoadingLock = new object();
    public IEnumerable Items
    {
        get
        {
            return (IEnumerable)this.GetValue(ItemsProperty);
        }
        set
        {
            this.SetValue(ItemsProperty, value);
        }
    }
    public AsyncListUserControl()
    {
        InitializeComponent();
    }
    private void InitializeItemsAsync(IEnumerable items)
    {
        lock(_itemsLoadingLock)
        {
            if (_itemsLoadiog!=null)
            {
                _itemsLoadiog.Cancel();
            }
            _itemsLoadiog = new CancellationTokenSource();
        }
        listView.IsEnabled = false;
        itemsLoadingIndicator.Visibility = Visibility.Visible;
        this.listView.Items.Clear();
        ItemsLoadingState state = new ItemsLoadingState(_itemsLoadiog.Token, this.Dispatcher, items);
        Task.Factory.StartNew(() =>
        {
            int pendingItems = 0;
            ManualResetEvent pendingItemsCompleted = new ManualResetEvent(false);
            foreach(object item in state.Items)
            {
                if (state.CancellationToken.IsCancellationRequested)
                {
                    pendingItemsCompleted.Set();
                    return;
                }
                Interlocked.Increment(ref pendingItems);
                pendingItemsCompleted.Reset();
                state.Dispatcher.BeginInvoke(
                    DispatcherPriority.Background,
                    (Action<object>)((i) =>
                    {
                        if (state.CancellationToken.IsCancellationRequested)
                        {
                            pendingItemsCompleted.Set();
                            return;
                        }
                        this.listView.Items.Add(i);
                        if (Interlocked.Decrement(ref pendingItems) == 0)
                        {
                            pendingItemsCompleted.Set();
                        }
                    }), item);
            }
            pendingItemsCompleted.WaitOne();
            state.Dispatcher.Invoke(() =>
            {
                if (state.CancellationToken.IsCancellationRequested)
                {
                    pendingItemsCompleted.Set();
                    return;
                }
                itemsLoadingIndicator.Visibility = Visibility.Collapsed;
                listView.IsEnabled = true;
            });
        });
    }
    private class ItemsLoadingState
    {
        public CancellationToken CancellationToken { get; private set; }
        public Dispatcher Dispatcher { get; private set; }
        public IEnumerable Items { get; private set; }
        public ItemsLoadingState(CancellationToken cancellationToken, Dispatcher dispatcher, IEnumerable items)
        {
            CancellationToken = cancellationToken;
            Dispatcher = dispatcher;
            Items = items;
        }
    }
}

使用示例:

<Window x:Class="WpfApplication1.MainWindow"
        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:WpfApplication1"
        mc:Ignorable="d"
        Title="MainWindow" Height="350" Width="525">
    <Window.DataContext>
        <local:MainWindowViewModel/>
    </Window.DataContext>
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"/>
            <RowDefinition/>
        </Grid.RowDefinitions>
        <Button Content="Load Items" Command="{Binding LoadItemsCommand}" />
        <local:AsyncListUserControl Grid.Row="1" Items="{Binding Items}"/>
    </Grid>
</Window>

视图模型:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Windows.Input;
namespace WpfApplication1
{
    public class MainWindowViewModel:INotifyPropertyChanged
    {
        private readonly ICommand _loadItemsCommand;
        private IEnumerable<string> _items;
        public event PropertyChangedEventHandler PropertyChanged;
        public MainWindowViewModel()
        {
            _loadItemsCommand = new DelegateCommand(LoadItemsExecute);
        }
        public IEnumerable<string> Items
        {
            get { return _items; }
            set { _items = value; OnPropertyChanged(nameof(Items)); }
        }
        public ICommand LoadItemsCommand
        {
            get { return _loadItemsCommand; }
        }
        private void LoadItemsExecute(object p)
        {
            Items = GenerateItems();
        }
        private IEnumerable<string> GenerateItems()
        {
            for(int i=0; i<10000; ++i)
            {
                yield return "Item " + i;
            }
        }
        private void OnPropertyChanged(string propertyName)
        {
            var h = PropertyChanged;
            if (h!=null)
            {
                PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
            }
        }
        public class DelegateCommand : ICommand
        {
            private readonly Predicate<object> _canExecute;
            private readonly Action<object> _execute;
            public event EventHandler CanExecuteChanged;
            public DelegateCommand(Action<object> execute) : this(execute, null) { }
            public DelegateCommand(Action<object> execute, Predicate<object> canExecute)
            {
                _execute = execute;
                _canExecute = canExecute;
            }
            public bool CanExecute(object parameter)
            {
                if (_canExecute == null)
                {
                    return true;
                }
                return _canExecute(parameter);
            }
            public void Execute(object parameter)
            {
                _execute(parameter);
            }
            public void RaiseCanExecuteChanged()
            {
                if (CanExecuteChanged != null)
                {
                    CanExecuteChanged(this, EventArgs.Empty);
                }
            }
        }
    }
}

这种方法的主要特点:

  1. 需要大量 UI 的数据的自定义依赖项属性初始化。

  2. DependencyPropertyChanged 回调启动管理UI 初始化。

  3. 工作线程调度执行优先级较低的小操作到 UI 线程中,使 UI 负责。

  4. 附加逻辑以保持一致状态,以防万一再次执行初始化,而先前的初始化未执行已完成。

另一种方法是从 UserControl hidden 和 IsBusy on true 开始。在 Application.Dispatcher 上的单独线程中开始加载。胎面的最后陈述是 IsBusy=false;UserControl.Visibility = Visibility.Visible;