循序漸進介紹基於CommunityToolkit.Mvvm 和HandyControl的WPF應用端開發(3)--自定義用戶控制項

来源:https://www.cnblogs.com/wuhuacong/archive/2023/09/13/17698705.html
-Advertisement-
Play Games

在我們創建界面元素的時候,不管在Vue3+ElementPlus的前端上,還是Winform桌面端上,都是會利用自定義用戶控制項來快速重用一些自定義的界面內容,對自定義用戶控制項的封裝處理,也是我們開發WPF應用需要熟悉的一環。本篇隨筆繼續深入介紹介紹基於CommunityToolkit.Mvvm 和H... ...


在我們創建界面元素的時候,不管在Vue3+ElementPlus的前端上,還是Winform桌面端上,都是會利用自定義用戶控制項來快速重用一些自定義的界面內容,對自定義用戶控制項的封裝處理,也是我們開發WPF應用需要熟悉的一環。本篇隨筆繼續深入介紹介紹基於CommunityToolkit.Mvvm 和HandyControl的WPF應用端開發,主要針對自定義用戶控制項的封裝和使用做一些介紹。

1、自定義用戶控制項的應用場景

在我們使用原生的WPF控制項的時候,有時候發現常規的原生控制項不夠好看,或者功能達不到要求,就需要進行一定程度上的二次封裝處理,也就是自定義控制項的開發場景。

例如我們前面介紹到的用戶信息的查詢界面,我們沒有找到一個輸入數值範圍的控制項,如對於年齡等類似的屬性,我們需要一個區間的查詢處理,可以保留為空,或者最小、最大值之間進行查詢,如下界面所示。

由於WPF沒有這樣的原生控制項,我們需要的話,就需要使用常規的數值或者文本控制項來進行處理,如果多次有這樣的內容,封裝為自定義控制項,讓她簡單的使用,是最為優雅的方式。

我們看到控制項的外觀如下所示。

 

2、自定義控制項的開發代碼

我們可以用Grid佈局來進行處理,包括兩個TextBlock和兩個文本的控制項界面,我們創建自定義控制項後,在Xaml定義好佈局信息。

<UserControl
    x:Class="WHC.SugarProject.WpfUI.Controls.NumericRange"
    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:hc="https://handyorg.github.io/handycontrol"
    xmlns:local="clr-namespace:WHC.SugarProject.WpfUI.Controls"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    Name="NumericRangeControl"
    d:Background="Transparent"
    d:DesignHeight="32"
    d:DesignWidth="150"
    d:Foreground="White"
    mc:Ignorable="d">
    <Grid MinWidth="150">
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="Auto" />
            <ColumnDefinition Width="*" />
            <ColumnDefinition Width="Auto" />
            <ColumnDefinition Width="*" />
        </Grid.ColumnDefinitions>
        <TextBlock
            Grid.Column="0"
            Margin="10,0,10,0"
            VerticalAlignment="Center"
            Text="{Binding Path=Text, RelativeSource={RelativeSource AncestorType={x:Type local:NumericRange}}}" />
        <TextBox
            x:Name="txtStart"
            Grid.Column="1"
            Margin="5"
            Text="{Binding Path=StartValue, Converter={StaticResource NumericConverter}, RelativeSource={RelativeSource AncestorType={x:Type local:NumericRange}}}" />
        <TextBlock
            Grid.Column="2"
            Margin="5,0,5,0"
            VerticalAlignment="Center"
            Text="~" />
        <TextBox
            x:Name="txtEnd"
            Grid.Column="3"
            Margin="5"
            Text="{Binding Path=EndValue, Converter={StaticResource NumericConverter}, RelativeSource={RelativeSource AncestorType={x:Type local:NumericRange}}}" />
    </Grid>
</UserControl>

其中綁定動態屬性的地方,我們使用下麵代碼

 Text="{Binding Path=StartValue, Converter={StaticResource NumericConverter}, RelativeSource={RelativeSource AncestorType={x:Type local:NumericRange}}}" 

當然也可以使用Element的標記方式,這種我們需要設置用戶自定義控制項名稱為Name=“***”,如上面的代碼設置為。

Name="NumericRangeControl"

這樣我們就可以通過自定義控制項的ElementName來定位綁定的屬性了,等同於如下代碼。

<TextBox
            x:Name="txtStart"
            Grid.Column="1"
            Margin="5"
            Text="{Binding Path=StartValue, Converter={StaticResource NumericConverter}, ElementName=NumericRangeControl}" />

前面我們介紹了該控制項包含了的一些屬性,如StartValue、EndValue、以及文本說明Text等,這些是在用戶控制項後臺代碼裡面進行定義的自定義依賴屬性的,我們來看看代碼。

 如我們增加一個StartValue,那麼同時需要增加一個StartValueProperty的自定義依賴屬性。

        /// <summary>
        /// 開始值
        /// </summary>
        public decimal? StartValue
        {
            get { return (decimal?)GetValue(StartValueProperty); }
            set { SetValue(StartValueProperty, value); }
        }

        public static readonly DependencyProperty StartValueProperty = DependencyProperty.Register(
            nameof(StartValue), typeof(decimal?), typeof(NumericRange),
            new FrameworkPropertyMetadata(default(decimal?), FrameworkPropertyMetadataOptions.BindsTwoWayByDefault, new PropertyChangedCallback(OnStartValuePropertyChanged)));

同時,這個屬性的變化,會觸發一個控制項路由的事件OnStartValuePropertyChanged ,如下所示。

        private static void OnStartValuePropertyChanged(DependencyObject d,DependencyPropertyChangedEventArgs e)
        {
            if (d is not NumericRange control)
                return;

            if (control != null)
            {
                var oldValue = (decimal?)e.OldValue;  // 舊的值
                var newValue = (decimal?)e.NewValue; // 更新的新的值

                var args = new RoutedPropertyChangedEventArgs<decimal?>(oldValue, newValue);
                args.RoutedEvent = NumericRange.ValueChangedEvent;
                control.RaiseEvent(args);
                control.ValueChangedCommand?.Execute(null);
            }
        }

除了觸發路由事件外,我們可以給該控制項定義一個Command 命令,類似按鈕的命令處理,綁定後就可以接受到相關的通知了。Command的定義如下代碼所示。

        /// <summary>
        /// 數量改變命令
        /// </summary>
        public static readonly DependencyProperty ValueChangedCommandProperty =
            DependencyProperty.Register("ValueChangedCommand", typeof(ICommand), typeof(NumericRange), new PropertyMetadata(default(ICommand)));

        /// <summary>
        /// 數量改變命令
        /// </summary>
        public ICommand ValueChangedCommand
        {
            get { return (ICommand)GetValue(ValueChangedCommandProperty); }
            set { SetValue(ValueChangedCommandProperty, value); }
        }

3、自定義控制項的使用

自定義控制項開發好後,使用也是很簡單的,需要在頁面或者視窗的定義部分,增加控制項的命名空間,便於引用自定義控制項,如下代碼所示。

 xmlns:Controls="clr-namespace:WHC.SugarProject.WpfUI.Controls"

這樣我們在使用的時候,就和其他原生控制項的使用差不多了。如下是在頁面中使用的Xaml代碼。

 <Controls:NumericRange
      EndValue="{Binding ViewModel.PageDto.AgeEnd, UpdateSourceTrigger=PropertyChanged}"
      StartValue="{Binding ViewModel.PageDto.AgeStart, UpdateSourceTrigger=PropertyChanged}"
      Text="年齡"
      ValueChangedCommand="{Binding ViewModel.SearchCommand}" />

我們可以看到自定義控制項的屬性的綁定,和其他控制項的屬性綁定一致的,而且我們這裡定義了一個Command:ValueChangedCommand

我們可以通過這個命令接收控制項變化的通知。這樣就可以正常的實現我們所需要的處理功能了。

另外,自定義控制項的輸入框,一般會在失去焦點後觸發命令處理,我們也可以讓文本輸入框在輸入後回車觸發命令處理,我們增加一個KeyDown的事件處理,如下代碼所示。

        <TextBox
            x:Name="txtStart"
            Grid.Column="1"
            Margin="5"
            KeyDown="txtStartEndValue_KeyDown"
            Text="{Binding Path=StartValue, Converter={StaticResource NumericConverter}, ElementName=NumericRangeControl}" />

        <TextBlock
            Grid.Column="2"
            Margin="5,0,5,0"
            VerticalAlignment="Center"
            Text="~" />

        <TextBox
            x:Name="txtEnd"
            Grid.Column="3"
            Margin="5"
            KeyDown="txtStartEndValue_KeyDown"
            Text="{Binding Path=EndValue, Converter={StaticResource NumericConverter}, RelativeSource={RelativeSource AncestorType={x:Type local:NumericRange}}}" />

讓回車切換到下一個焦點即可。

        private void txtStartEndValue_KeyDown(object sender, KeyEventArgs e)
        {
            if(e.Key == Key.Enter)
            {
                var textBox = sender as System.Windows.Controls.TextBox;
                if(textBox != null)
                {
                    //切換焦點會觸發值更新命令
                    textBox.MoveFocus(new TraversalRequest(FocusNavigationDirection.Next));
                }
            }
        }

至此我們就完成了完美的控制項處理事件了。

編譯後,我們就可以在工具欄中看到用戶自定義控制項的列表了,可以直接拖動它到頁面進行使用。

 至此,我們就實現了自定義控制項在頁面上的使用了,非常簡單。

 

 當然,我們也可以組合一些面板,來實現更加複雜的控制項呈現方式,可以設計一些圖表、文本內容的綜合展示,如下是其中的一個控制項的多層展示。

根據不同的圖標、內容,背景色、以及一些集合形狀的疊加,就可以設計出非常好看的單個用戶控制項,然後動態設置,就可以很好的實現不同的內容展示。

 

專註於代碼生成工具、.Net/.NetCore 框架架構及軟體開發,以及各種Vue.js的前端技術應用。著有Winform開發框架/混合式開發框架、微信開發框架、Bootstrap開發框架、ABP開發框架、SqlSugar開發框架等框架產品。
  轉載請註明出處:撰寫人:伍華聰  http://www.iqidi.com 
    

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

-Advertisement-
Play Games
更多相關文章
  • Matplotlib 提供了大量配置參數,這些參數可以但不限於讓我們從整體上調整通過 Matplotlib 繪製的圖形樣式,這裡面的參數還有很多是功能性的,和其他工具結合時需要用的配置。 通過plt.rcParams,可以查看所有的配置信息: import matplotlib.pyplot as ...
  • 大家好,我是TJ 今天給大家推薦一個開源協作式數字白板:tldraw。 tldraw的編輯器、用戶界面和其他底層庫都是開源的,你可以在它的開源倉庫中找到它們。它們也在NPM上分發,提供開發者使用。您可以使用tlDraw為您的產品創建一個臨時白板,或者將其作為構建自己應用的工具來使用。 線上體驗 tl ...
  • 基於java學生考勤管理系統設計與實現,可適用於學生考勤系統,校園考勤,大學考勤管理,企業考勤系統,公司考勤系統,學校考勤系統。 ...
  • 隨著JDK19的發佈,虛擬線程也逐漸被大家瞭解和使用,然而,主流java框架是否支持虛擬線程這一特性呢?咱們應用開發者如何通過框架使用虛擬線程特性?經過精心準備,欣宸原創在第一時間為您帶來詳細的實戰系列,與您共同學習 ...
  • 大家好,又見面了。 在此前我的文章中,曾分2篇詳細探討了下JAVA中Stream流的相關操作,2篇文章收穫了累計 10w+閱讀、2k+點贊以及 5k+收藏的記錄。能夠得到眾多小伙伴的認可,是技術分享過程中最開心的事情。 吃透JAVA的Stream流操作,多年實踐總結 講透JAVA Stream的co ...
  • 作者:美得讓人心動 來源:https://blog.csdn.net/gu131007416553/article/details/120934738 面試官在面試候選人時,如果發現候選人的簡歷中寫了在項目中使用了 MQ 技術(如 Kafka、RabbitMQ、RocketMQ),基本都會拋出一個問 ...
  • 以下內容均來自Gitee的開源倉庫,具體的使用請移步Gitee:https://gitee.com/pojianbing/lazy-captcha 以下是我自己使用的具體方式 首先安裝NuGet包: Microsoft.Extensions.Caching.StackExchangeRedis La ...
  • 首先需要安裝的NuGet包有: Microsoft.AspNetCore.Authentication.JwtBearer Swashbuckle.AspNetCore Swashbuckle.AspNetCore.Filters jose-jwt 大致是這些代碼放到項目中如果有報錯信息再去具體解決 ...
一周排行
    -Advertisement-
    Play Games
  • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
  • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
  • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
  • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
  • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...