[UWP]做個調皮的BusyIndicator

来源:https://www.cnblogs.com/dino623/archive/2018/02/28/BusyIndicator.html
-Advertisement-
Play Games

1. 前言 最近突然想要個BusyIndicator。做過WPF開發的程式員對BusyIndicator應該不陌生， "Extended WPF Toolkit" 提供了BusyIndicator的開源實現，Silverlight Toolkit也有一個，這次想要把這個控制項移植到UWP中。 2. 先 ...


1. 前言

最近突然想要個BusyIndicator。做過WPF開發的程式員對BusyIndicator應該不陌生，Extended WPF Toolkit 提供了BusyIndicator的開源實現，Silverlight Toolkit也有一個，這次想要把這個控制項移植到UWP中。

2. 先說點正經的

2.1 BusyIndicator的功能

BusyIndicator的功能很簡單，就是提示正在執行操作並遮擋不能被修改的內容。通常它派生自ContentControl並提供public bool IsBusy{ get; set; }屬性，當設置IsBusy=True時將Content.IsEnabled設置成False，並顯示Overlay、BusyContent和一個ProgressBar。在Silverlight中，它的UI如下：

2.2 移植

Extended WPF Toolkit和Silverlight Toolkit中的BusyIndicator實現基本一致，由於Silverlight和各個XAML平臺的相容性都比較好，我選擇了Silverlight Toolkit中的BusyIndicator用於移植。事實證明這是個正確的選擇，只改動了幾行代碼就完美移植成功了。

2.3 改進

既然UWP有ProgressRing，我就不想用ProgressBar來展示Busy的狀態。另外，雖然BusyIndicator的ControlTemplate已經夠精簡了，為了方便將來修改我再進一步簡化了XAML，結果如下：

<ContentControl x:Name="content"
                Content="{TemplateBinding Content}"
                ContentTemplate="{TemplateBinding ContentTemplate}"
                ContentTransitions="{TemplateBinding ContentTransitions}"
                HorizontalContentAlignment="{TemplateBinding HorizontalContentAlignment}"
                VerticalContentAlignment="{TemplateBinding VerticalContentAlignment}" />
<Rectangle x:Name="overlay"
           Style="{TemplateBinding OverlayStyle}" />
<ContentPresenter x:Name="busycontent">
    <Grid HorizontalAlignment="Center"
          VerticalAlignment="Center">
        <Grid.RowDefinitions>
            <RowDefinition />
            <RowDefinition Height="Auto" />
        </Grid.RowDefinitions>
        <ProgressRing x:Name="ProgressRing"
                      IsActive="True"
                      Style="{TemplateBinding ProgressRingStyle}" />

        <ContentPresenter Content="{TemplateBinding BusyContent}"
                          ContentTemplate="{TemplateBinding BusyContentTemplate}"
                          Grid.Row="1"
                          FontSize="15"
                          HorizontalAlignment="Center"
                          Foreground="{ThemeResource SystemControlHighlightAccentBrush}" />
    </Grid>
</ContentPresenter>

和Silverlight/WPF不同的是，需要在ContentControl上綁定ContentTransitions屬性。

UWP可以使用VisualState.Setters代替VisualState.Storyboard，這簡化了大量XAML，為什麼微軟早十年沒想到這個做法。

Silverlight的BusyIndicator：

<VisualStateManager.VisualStateGroups>
    <VisualStateGroup x:Name="VisibilityStates">
        <VisualState x:Name="Hidden">
            <Storyboard>
                <ObjectAnimationUsingKeyFrames BeginTime="00:00:00" Duration="00:00:00.001" Storyboard.TargetName="busycontent" Storyboard.TargetProperty="(UIElement.Visibility)">
                    <DiscreteObjectKeyFrame KeyTime="00:00:00">
                        <DiscreteObjectKeyFrame.Value>
                            <Visibility>Collapsed</Visibility>
                        </DiscreteObjectKeyFrame.Value>
                    </DiscreteObjectKeyFrame>
                </ObjectAnimationUsingKeyFrames>
                <ObjectAnimationUsingKeyFrames BeginTime="00:00:00" Duration="00:00:00.001" Storyboard.TargetName="overlay" Storyboard.TargetProperty="(UIElement.Visibility)">
                    <DiscreteObjectKeyFrame KeyTime="00:00:00">
                        <DiscreteObjectKeyFrame.Value>
                            <Visibility>Collapsed</Visibility>
                        </DiscreteObjectKeyFrame.Value>
                    </DiscreteObjectKeyFrame>
                </ObjectAnimationUsingKeyFrames>
            </Storyboard>
        </VisualState>
        <VisualState x:Name="Visible">
            <Storyboard>
                <ObjectAnimationUsingKeyFrames BeginTime="00:00:00" Duration="00:00:00.001" Storyboard.TargetName="busycontent" Storyboard.TargetProperty="(UIElement.Visibility)">
                    <DiscreteObjectKeyFrame KeyTime="00:00:00">
                        <DiscreteObjectKeyFrame.Value>
                            <Visibility>Visible</Visibility>
                        </DiscreteObjectKeyFrame.Value>
                    </DiscreteObjectKeyFrame>
                </ObjectAnimationUsingKeyFrames>
                <ObjectAnimationUsingKeyFrames BeginTime="00:00:00" Duration="00:00:00.001" Storyboard.TargetName="overlay" Storyboard.TargetProperty="(UIElement.Visibility)">
                    <DiscreteObjectKeyFrame KeyTime="00:00:00">
                        <DiscreteObjectKeyFrame.Value>
                            <Visibility>Visible</Visibility>
                        </DiscreteObjectKeyFrame.Value>
                    </DiscreteObjectKeyFrame>
                </ObjectAnimationUsingKeyFrames>
            </Storyboard>
        </VisualState>
    </VisualStateGroup>
    <VisualStateGroup x:Name="BusyStatusStates">
        <VisualState x:Name="Idle">
            <Storyboard>
                <ObjectAnimationUsingKeyFrames BeginTime="00:00:00" Duration="00:00:00.001" Storyboard.TargetName="content" Storyboard.TargetProperty="(Control.IsEnabled)">
                    <DiscreteObjectKeyFrame KeyTime="00:00:00">
                        <DiscreteObjectKeyFrame.Value>
                            <sys:Boolean>True</sys:Boolean>
                        </DiscreteObjectKeyFrame.Value>
                    </DiscreteObjectKeyFrame>
                </ObjectAnimationUsingKeyFrames>
            </Storyboard>
        </VisualState>
        <VisualState x:Name="Busy">
            <Storyboard>
                <ObjectAnimationUsingKeyFrames BeginTime="00:00:00" Duration="00:00:00.001" Storyboard.TargetName="content" Storyboard.TargetProperty="(Control.IsEnabled)">
                    <DiscreteObjectKeyFrame KeyTime="00:00:00">
                        <DiscreteObjectKeyFrame.Value>
                            <sys:Boolean>False</sys:Boolean>
                        </DiscreteObjectKeyFrame.Value>
                    </DiscreteObjectKeyFrame>
                </ObjectAnimationUsingKeyFrames>
            </Storyboard>
        </VisualState>
    </VisualStateGroup>
</VisualStateManager.VisualStateGroups>

UWP的BusyIndicator

<VisualStateManager.VisualStateGroups>
    <VisualStateGroup x:Name="VisibilityStates">
        <VisualState x:Name="Hidden">
            <VisualState.Setters>
                <Setter Target="overlay.(UIElement.Visibility)"
                        Value="Collapsed" />
                <Setter Target="busycontent.(UIElement.Visibility)"
                        Value="Collapsed" />
            </VisualState.Setters>
        </VisualState>
        <VisualState x:Name="Visible" />
    </VisualStateGroup>
    <VisualStateGroup x:Name="BusyStatusStates">
        <VisualState x:Name="Idle" />
        <VisualState x:Name="Busy">
            <VisualState.Setters>
                <Setter Target="content.(Control.IsEnabled)"
                        Value="False" />
            </VisualState.Setters>
        </VisualState>
    </VisualStateGroup>
</VisualStateManager.VisualStateGroups>

2.3 其它細節

<Setter Property="BusyContent"
        Value="Please wait..." />
<Setter Property="IsTabStop"
        Value="False" />
<Setter Property="OverlayStyle">
    <Setter.Value>
        <Style TargetType="Rectangle">
            <Setter Property="Fill"
                    Value="{ThemeResource ApplicationForegroundThemeBrush}" />
            <Setter Property="Opacity"
                    Value="0.2" />
        </Style>
    </Setter.Value>
</Setter>
<Setter Property="ProgressRingStyle">
    <Setter.Value>
        <Style TargetType="ProgressRing">
            <Setter Property="Height"
                    Value="50" />
            <Setter Property="Width"
                    Value="50" />
            <Setter Property="Margin"
                    Value="8,8,8,0" />
        </Style>
    </Setter.Value>
</Setter>
<Setter Property="DisplayAfter"
        Value="00:00:00.1" />
<Setter Property="HorizontalAlignment"
        Value="Stretch" />
<Setter Property="VerticalAlignment"
        Value="Stretch" />
<Setter Property="HorizontalContentAlignment"
        Value="Stretch" />
<Setter Property="VerticalContentAlignment"
        Value="Stretch" />

上面是BusyIndicator DefaultStyle的Setters，有一些細節是實現模板化控制項需要註意的：

BusyContent
BusyContent沒有在依賴屬性定義中的PropertyMetadata給出預設值，而是在Setter中給出，這是模板化控制項中依賴屬性的最佳做法。PropertyMetadata的預設值應該儘量做到：值類型使用值類型的預設值，引用類型使用Null。

IsTabStop
已經不厭其煩地提醒過複合類型控制項要將IsTabStop設置為False，以便在使用鍵盤導航時其內容可以直接獲得焦點。

OverlayStyle和ProgressRingStyle
複合類型控制項通常都會像這樣為裡面某個元素提供Style的屬性，代替提供一大堆OverlayBackground，OverlayOpacity等屬性。為了使用戶清楚這兩個Style屬性對應的TargetType，可以在BusyIndicator的類型聲明上使用StyleTypedPropertyAttribute：

[StyleTypedProperty(Property = "OverlayStyle", StyleTargetType = typeof(Rectangle))]
[StyleTypedProperty(Property = "ProgressRingStyle", StyleTargetType = typeof(ProgressRing))]

IsTabStop和StyleTypedPropertyAttribute的介紹都可見我另一篇文章：瞭解模板化控制項(9)：UI指南

HorizontalContentAlignment和VerticalContentAlignment
使用ContentControl時幾乎每次都要設置HorizontalContentAlignment和VerticalContentAlignment為Stretch，SilverlightToolkit中BusyIndicator的作者就很清楚這點。

這兩個屬性和BusyContent不同，並不是BusyIndicator定義的，而是從父類繼承而來。像這種從父類繼承而來的屬性通常不會在構造函數中設置預設值，而是在DefaultStyle的Setter中設置預設值。

2.4 運行效果

就這樣一個BusyIndicator就移植成功了。由於代碼部分基本沒有改變（除了ProgressBarStyle改成ProgressRingStyle），應該不會出什麼大問題。運行效果如下：

<busyIndicatorSample:BusyIndicator x:Name="BusyIndicator">
    <Button HorizontalAlignment="Center"
            VerticalAlignment="Center"
            Content="Login"
            Click="Button_Click"
            Margin="0,0,0,150" />
</busyIndicatorSample:BusyIndicator>
private async void Button_Click(object sender, RoutedEventArgs e)
{
    BusyIndicator.IsBusy = true;
    await Task.Delay(TimeSpan.FromSeconds(3));
    BusyIndicator.IsBusy = false;
}

3. 來點調皮的

突然來了點興緻，於是就派生出新的控制項ExtendBusyIndicator並新增public object BusyInformation{ get; set; }和public object IdleInformation{ get; set; }兩個屬性，運行效果如下：

XAML:

<busyIndicatorSample:ExtendBusyIndicator x:Name="BusyIndicator"
                                         Background="White">
    <busyIndicatorSample:ExtendBusyIndicator.BusyInformation>
        <StackPanel>
            <TextBlock Text="十年後"
                       HorizontalAlignment="Center" />
            <TextBlock Text="10 years later"
                       HorizontalAlignment="Center"
                       Margin="0,2,0,0" />
        </StackPanel>
    </busyIndicatorSample:ExtendBusyIndicator.BusyInformation>
    <busyIndicatorSample:ExtendBusyIndicator.IdleInformation>
        <StackPanel>
            <TextBlock Text="這個網頁終於載入完了"
                       HorizontalAlignment="Center" />
            <TextBlock Text="the Web page finally finished loading."
                       HorizontalAlignment="Center"
                       Margin="0,2,0,0" />
        </StackPanel>
    </busyIndicatorSample:ExtendBusyIndicator.IdleInformation>

    <Button Style="{StaticResource ButtonRevealStyle}"
            Padding="0"
            HorizontalAlignment="Center"
            Background="Transparent"
            Margin="0,0,0,150"
            Click="Button_Click">
        <Image Source="logo1.png"
               Width="80" />
    </Button>
</busyIndicatorSample:ExtendBusyIndicator>

4. 莓良心的

5. 結語

BusyIndicator十分實用，畢竟已經經過多年的考驗而代碼基本沒有更改，應該可以使用在UWP的實際項目中。

其實我個人不是很喜歡IsBusy就將Content.IsEnabled設置成False這麼簡單粗暴，因為這樣內容會變成灰色。而且busyContent顯示的過程應該是個透明度漸變的過程。這兩個點使得執行很快的操作會令UI閃爍一下。而且ControlTemplate中ProgressRing和Overlay的父元素是一個叫busyContent的Grid，但BusyContent（註意大小些）是BusyIndicator的一個屬性，內容是Busy狀態下顯示的文字內容，這樣很容易讓人混淆。幸運的是模板化控制項最大的特色就是對修改UI是開放的，將來可以想辦法修改。

ExtendBusyIndicator就算了，鬧著玩的。

6. 參考

Extended WPF Toolkit
Silverlight Toolkit - CodePlex Archive
UWP BusyIndicator · telerik UI For UWP

7. 源碼

BusyIndicatorSample


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 哈希表詳解
    哈希表（Hash table，也叫散列表），是根據關鍵碼值(Key value)而直接進行訪問的數據結構。也就是說，它通過把關鍵碼值映射到表中一個位置來訪問記錄，以加快查找的速度。這個映射函數叫做散列函數，存放記錄的數組叫做散列表。 順序搜索以及二叉樹搜索樹中，元素存儲位置和元素各關鍵碼之間沒有對應 ...
  • springBoot之配置文件的讀取以及過濾器和攔截器的使用
    前言 在之前的學習 "springBoot" 中，成功的實現了Restful風格的基本服務。但是想將之前的工程作為一個項目來說，那些是僅僅不夠的。可能還需要獲取自定義的配置以及添加過濾器和攔截器。至於為什麼將這些寫在一起，只是因為這些比較簡單而且也會經常用到，所以乾脆就一起寫出來了。 讀取配置文件 ...
  • 詳解HASH【string】
    HASH意為（散列），是OI的常用演算法。 我們常用哈希的原因是，hash可以快速（一般來說是O(段長)）的求出一個子段的hash值，然後就可以快速的判斷兩個串是否相同。 今天先講string類的hash。 可以發現，與一個string有關的HASH值不僅僅跟每個字元的個數有關，還和字元的位子有關。 ...
  • Python+Selenium筆記（十二）：數據驅動測試
    (一) 前言 通過使用數據驅動測試，實現對輸入值和預期結果的參數化。（例如：輸入數據和預期結果可以直接讀取Excel文檔的數據） (二) ddt 使用ddt執行數據驅動測試，ddt庫可以將測試中的變數參數化。使用ddt的時候，在測試類上使用@ddt裝飾符，在測試方法上使用@data裝飾符。@data ...
  • 洛谷P1333 瑞瑞的木棍
    題目描述 瑞瑞有一堆的玩具木棍，每根木棍的兩端分別被染上了某種顏色，現在他突然有了一個想法，想要把這些木棍連在一起拼成一條線，並且使得木棍與木棍相接觸的兩端顏色都是相同的，給出每根木棍兩端的顏色，請問是否存在滿足要求的排列方式。 例如，如果只有2根木棍，第一根兩端的顏色分別為red,blue，第二根 ...
  • 2-SAT速成
    本文只做總結性說明 2 SAT 2 SAT是k SAT問題的一種，k SAT問題在$k =3$時已經被證明是NP完全問題 2 SAT問題定義比較簡單 有n個布爾變數$x_1 x_n$。給出$m$個限制關係，每個關係最多只對兩個變數進行限制。求一組取值使得滿足所有限制。 這裡的限制例如：選$A$必選$ ...
  • Windows下Python的安裝
    Python官網：https://www.python.org/blogs/ 下載所需的python版本 下載好後雙擊運行安裝程式 下麵勾選 → 點擊Install Now 進行安裝 完成後在命令框中輸入 python 即可查看 ...
  • ASP.NET Core Logging in Elasticsearch with Kibana
    在微服務化盛行的今天，日誌的收集、分析越來越重要。ASP.NET Core 提供了一個統一的，輕量級的Logining系統，並可以很方便的與第三方日誌框架集成。我們也可以根據不同的場景進行擴展，因為ASP.NET Core Logining系統設計的非常靈活性，我們可以很容易的添加自己的LogPro ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類