Avalonia的模板控制元件（Templated Controls）

chester·chen發表於2024-04-08
控制元件

在Avalonia的UI框架中，TemplatedControl是一個核心元件，它提供了一種強大的方式來建立可重用且高度可定製的控制元件。

本文將深入探討TemplatedControl的概念、其帶來的優勢以及它在實際開發中的應用場景，並透過一個示例程式碼來展示其用法。

什麼是TemplatedControl

TemplatedControl是Avalonia中一個特殊的控制元件型別，它允許開發者定義控制元件的模板結構。

這個模板可以包含其他控制元件、佈局、資料繫結等，從而定義控制元件的外觀和行為。

透過將控制元件的邏輯和外觀分離，TemplatedControl提供了一種更加靈活和可維護的方式來建立控制元件。

在TemplatedControl中，開發者可以定義一些模板繫結點，這些繫結點允許在例項化控制元件時，將特定的子控制元件或資料繫結到模板中的對應位置。這

種機制使得控制元件具有極大的靈活性，可以適應各種不同的使用場景。

TemplatedControl的優勢

  1. 高度可定製：TemplatedControl允許開發者透過修改模板來定製控制元件的外觀和行為，從而滿足不同的設計需求。

  2. 邏輯與外觀分離：透過將控制元件的邏輯和外觀分離，TemplatedControl使得程式碼更加清晰、易於維護。開發者可以專注於實現控制元件的功能邏輯，而不需要關心其外觀的呈現。

  3. 提高複用性：透過定義通用的TemplatedControl，並在不同的地方使用不同的模板來例項化它，可以大大提高程式碼的複用性，減少重複勞動。

  4. 易於擴充套件：TemplatedControl的設計使得它很容易進行擴充套件。開發者可以繼承現有的TemplatedControl並新增自定義的邏輯和模板，從而建立出具有特定功能的控制元件。

TemplatedControl的應用場景

TemplatedControl在Avalonia UI開發中有著廣泛的應用場景。以下是一些常見的應用場景：

  1. 自定義控制元件：開發者可以使用TemplatedControl來建立具有獨特外觀和行為的自定義控制元件，如自定義按鈕、自定義列表框等。

  2. 資料展示控制元件：對於需要展示資料的場景，如列表、表格、樹形控制元件等，TemplatedControl可以提供一個靈活的模板來定義資料的展示方式。

  3. 主題和樣式：透過修改TemplatedControl的模板，可以輕鬆實現應用程式的主題切換和樣式定製。

示例程式碼

下面是一個簡單的TemplatedControl示例，展示如何建立一個自定義的控制元件：

首先，我們定義模板讓其包含一個Button和ContentPresenter。

其中Button使用TemplateBinding繫結Content屬性。ContentPresenter展示呼叫時的子控制元件。

TemplatedControl1.axaml

<Styles xmlns="https://github.com/avaloniaui"
        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:controls="using:AvaloniaApplication1">
    <Design.PreviewWith>
        <controls:TemplatedControl1 />
    </Design.PreviewWith>

    <Style Selector="controls|TemplatedControl1">
        <!-- Set Defaults -->
        <Setter Property="Template">
            <ControlTemplate>
                <StackPanel>
                    <Button Name="PART_Button" Content="{TemplateBinding Content}" />
                    <ContentPresenter ContentTemplate="{TemplateBinding ContentTemplate}" Name="contentPresenter" HorizontalAlignment="Stretch" VerticalAlignment="Stretch"/>
                </StackPanel>
            </ControlTemplate>
        </Setter>
    </Style>
</Styles>

然後，在C#程式碼中實現類，需要定義Button的Content屬性，點選事件，和ContentPresenter的子內容

TemplatedControl1.axaml.cs

using Avalonia;
using Avalonia.Controls;
using Avalonia.Controls.Presenters;
using Avalonia.Controls.Primitives;
using Avalonia.Controls.Templates;
using Avalonia.Interactivity;
using Avalonia.Markup.Xaml.Templates;
using Avalonia.Metadata;
using System;
using System.Linq;

namespace AvaloniaApplication1
{
    public class TemplatedControl1 : TemplatedControl
    {
        public static readonly StyledProperty<string> ContentProperty =
            AvaloniaProperty.Register<TemplatedControl1, string>(nameof(Content));

        public string Content
        {
            get { return GetValue(ContentProperty); }
            set { SetValue(ContentProperty, value); }
        }

        public static readonly RoutedEvent<RoutedEventArgs> ClickEvent =
            RoutedEvent.Register<TemplatedControl1, RoutedEventArgs>(nameof(Click), RoutingStrategies.Bubble);


        public event EventHandler<RoutedEventArgs> Click
        {
            add => AddHandler(ClickEvent, value);
            remove => RemoveHandler(ClickEvent, value);
        }

        private void OnClick(object sender, RoutedEventArgs e)
        {
            RaiseEvent(new RoutedEventArgs(ClickEvent));
        }

        public static readonly StyledProperty<DataTemplate> ContentTemplateProperty =
             AvaloniaProperty.Register<TemplatedControl1, DataTemplate>(nameof(ContentTemplate));

        [Content]
        public IDataTemplate ContentTemplate
        {
            get => GetValue(ContentTemplateProperty);
            set => SetValue(ContentTemplateProperty, value);
        }

        public override void EndInit()
        {
            base.EndInit();
            ApplyTemplate();

            var childs = this.GetTemplateChildren().ToList();
            var button = childs.FirstOrDefault(e => e.Name == "PART_Button");
            if (button != null)
            {
                ((Button)button).Click += OnClick;
            }

            // Apply the content template to the ContentPresenter
            //var contentPresenter = childs.FirstOrDefault(e => e.Name == "contentPresenter");
            //((ContentPresenter)contentPresenter).ContentTemplate = ContentTemplate;
        }
    }
}

並在App.axaml中使用StyleInclude宣告此控制元件

App.axaml

<Application xmlns="https://github.com/avaloniaui"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             x:Class="AvaloniaApplication1.App"
             xmlns:local="using:AvaloniaApplication1"
             RequestedThemeVariant="Default">
             <!-- "Default" ThemeVariant follows system theme variant. "Dark" or "Light" are other available options. -->

    <Application.DataTemplates>
        <local:ViewLocator/>
    </Application.DataTemplates>
  
    <Application.Styles>
        <FluentTheme />
        <StyleInclude Source="CControls/TemplatedControl1.axaml"/>
    </Application.Styles>
</Application>

最後在MainWindow.axaml中使用此控制元件，併為此控制元件傳遞Content，Click屬性，和DataTemplate的子內容

MainWindow.axaml

<Window xmlns="https://github.com/avaloniaui"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:vm="using:AvaloniaApplication1.ViewModels"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:AvaloniaApplication1"
        mc:Ignorable="d" d:DesignWidth="800" d:DesignHeight="450"
        x:Class="AvaloniaApplication1.Views.MainWindow"
        x:DataType="vm:MainWindowViewModel"
        Icon="/Assets/avalonia-logo.ico"
        Title="AvaloniaApplication1">

    <Design.DataContext>
        <vm:MainWindowViewModel/>
    </Design.DataContext>

    <local:TemplatedControl1 Content="test control" Click="HandleButtonClick">
        <DataTemplate>
            <Button Content="Click Me"/>
        </DataTemplate>
    </local:TemplatedControl1>
</Window>

MainWindow.axaml.cs中定義HandleButtonClick

MainWindow.axaml.cs

public void HandleButtonClick(object sender, RoutedEventArgs e)
{
    Debug.WriteLine("click");
}

執行即可檢視到效果

相關文章