Avalonia中如何实现类似WPF的TemplatePart声明与GetTemplateChild控件引用功能

1. 声明模板控件约定 #

和WPF的使用逻辑一致，你可以在自定义控件的类上添加[TemplatePart]特性，声明模板中需要用到的控件的约定名称和类型，通常约定名称以PART_为前缀，是模板控件开发的通用规范。
示例代码：

using Avalonia.Controls;
using Avalonia.Controls.Templates;

// 声明模板部件约定
[TemplatePart(Name = "PART_InputBox", Type = typeof(TextBox))]
[TemplatePart(Name = "PART_SubmitBtn", Type = typeof(Button))]
public class CustomFormControl : TemplatedControl
{
    // 自定义控件的其他逻辑
}

2. 重载生命周期方法获取控件实例 #

你需要重载TemplatedControl的OnApplyTemplate方法，在这个方法内调用GetTemplateChild方法传入约定的控件名称，即可获取到对应控件的引用，拿到引用后可以做事件绑定、初始化赋值等操作。
示例代码：

private TextBox? _inputBox;
private Button? _submitBtn;

protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
{
    base.OnApplyTemplate(e);

    // 获取模板内的控件引用
    _inputBox = GetTemplateChild<TextBox>("PART_InputBox");
    _submitBtn = GetTemplateChild<Button>("PART_SubmitBtn");

    // 初始化逻辑
    if (_submitBtn != null)
    {
        _submitBtn.Click += OnSubmitBtnClicked;
    }
}

private void OnSubmitBtnClicked(object? sender, RoutedEventArgs e)
{
    if (_inputBox?.Text is not null)
    {
        // 处理提交逻辑
    }
}

注意事项 #

• GetTemplateChild如果找不到对应名称/类型的控件会返回null，使用前必须做空值判断，避免触发空引用异常
• 不要在控件的构造函数中调用GetTemplateChild方法，此时控件模板还未加载，必然返回null，所有模板相关的初始化操作都要放在OnApplyTemplate中执行
• 控件销毁时建议解绑OnApplyTemplate中绑定的事件，避免出现内存泄漏问题

内容的提问来源于stack exchange，提问作者Etienne Charland