[WPF]標記擴充套件(Markup Extension)

czwy發表於2023-11-16

XAML是基於XML的語言,其遵循並擴充套件了XML的語法規則。其中一項擴充套件就是標記擴充套件(Markup Extension),比如我們經常使用的繫結Bindingx:Type

什麼是標記擴充套件

標記擴充套件允許在XAML標記中使用特殊的語法來動態地為特性(Attribute)賦值或執行其他操作。簡單來說,在XAML中,所有為XAML元素特性(Attribute)賦值時,使用花括號{}包裹起來的語句就是標記擴充套件。這麼定義不是特別嚴謹,因為轉義序列也是以花括號{}作為標記的,但不是標記擴充套件。[1] 後邊提到的x:Array標記擴充套件使用的是<>。

標記擴充套件的語法是{標記擴充套件類 引數},所有的標記擴充套件類都是派生自System.Windows.MarkupExtension基類實現的。開篇提到的Bindingx:Type都是WPF框架內建的標記擴充套件。細心的朋友會發現這兩個標記擴充套件一個帶x:字首,一個不帶。這就不得不提WPF中的兩類標記擴充套件。

  • XAMl定義的標記擴充套件
  • 特定於 WPF 的標記擴充套件。

XAML定義的標記擴充套件

XAML定義的標記擴充套件在System.Xaml程式集中,位於XAML名稱空間內,並非WPF特定的實現。這類標記擴充套件通常由x:字首標識。主要有以下幾種:

  • x:Static 用於引用以符合公共語言規範 (CLS) 的方式定義的任何靜態按值程式碼實體。 可使用引用的靜態屬性在 XAML 中提供屬性的值。
  • x:Type 為命名型別提供 Type 物件。此擴充套件最常用於樣式和模板。
  • x:Array 透過標記擴充套件提供對 XAML 中物件的陣列的一般支援。需要注意的是,在 XAML 2009 中,x:Array定義為語言基元而不是標記擴充套件。[2]
  • x:Null 將 null 指定為屬性的值,可用於特性或屬性元素值。

特定於WPF的標記擴充套件

最常見的標記擴充套件是支援資源引用的標記擴充套件(StaticResource 和 DynamicResource),和支援資料繫結的標記擴充套件 (Binding)。特定於WPF的標記擴充套件有以下幾種:[3]

  • StaticResource 透過查詢對已定義資源的引用,為任何 XAML 屬性提供值。 查詢該資源的行為類似於載入時查詢,將查詢當前 XAML 頁面先前的標記以及其他應用程式源中載入的資源,並將生成該資源值作為執行時物件中的屬性值。該標記擴充套件要求引用的資源必須在引用之前宣告,否則載入時找不到資源報錯。
  • DynamicResource 透過將值推遲為對資源的執行時引用來為屬性提供值。 動態資源引用強制在每次訪問此類資源時都進行新查詢。該標記擴充套件引用的資源則對宣告的位置沒有太多要求,因為它在執行的時候採取查詢資源。
  • Binding 將屬性值延遲為資料繫結值,建立中間表示式物件並在執行時解釋應用於元素及其繫結的資料上下文。此標記擴充套件相對複雜,因為它會啟用大量內聯語法來指定資料繫結。
  • RelativeSource 在設定 XAML 中建立的 Binding 元素的 RelativeSource 屬性時使用。例如巢狀在 Binding 擴充套件內
<object property="{Binding RelativeSource={RelativeSource modeEnumValue} ...}" ... />
  • TemplateBinding 使控制元件模板能夠使用模板化屬性的值,這些屬性來自於將使用該模板的類的物件模型定義屬性。換言之,模板定義中的屬性可訪問僅在應用了模板之後才存在的上下文。
  • ColorConvertedBitmap 提供方法來指定沒有嵌入配置檔案的點陣圖源。 顏色上下文/配置檔案由 URI 指定,與影像源 URI 一樣。
<object property="{ColorConvertedBitmap imageSource sourceIIC destinationIIC}" ... />
  • ComponentResourceKey 定義和引用從外部程式集載入的資源的鍵。 這使資源查詢能夠在程式集中指定目標型別,而不是在程式集中或類上指定顯式資源字典。
  • ThemeDictionary 為整合第三方控制元件的自定義控制元件創作者或應用程式提供一種方法,用於載入要在設定控制元件樣式時使用的特定於主題的資源字典。

自定義標記擴充套件

上文提到所有的標記擴充套件類都是派生自System.Windows.MarkupExtension基類實現的。因此自定義標記擴充套件也需派生自這個基類。MarkupExtension僅提供一個簡單的ProvideValue(IServiceProvider serviceProvider)方法來獲取所期望的數值。接下來用個簡單的例子進行說明:

public class AddExtension : MarkupExtension
{
    private string _value;

    private string _value1;

    public string Value1
    {
        get => _value1;
        set => _value1 = value;
    }

    public AddExtension()
    {

    }

    public AddExtension(string par)
    {
        _value = par;
    }

    public override object ProvideValue(IServiceProvider serviceProvider)
    {
        if (_value == null) { throw new InvalidOperationException(); }

        int iv, iv1;
        if (int.TryParse(_value, out iv) && int.TryParse(Value1, out iv1))
        {
            return iv + iv1;
        }
        else
            return _value;
    }
}

這個自定義的標記擴充套件定義了一個帶參建構函式和一個屬性用於接收引數,並透過重寫ProvideValue方法返回兩個引數的和。以下程式碼是使用該標記擴充套件的示例。

<Button Content="{local:Add 2,Value1=5}"/>

根據約定,標記擴充套件的命名都是以Extension結尾,在引用擴充套件類時可以省略最後一個單詞Extension,示例中緊跟在local:Add後的2是作為建構函式的引數,Value1=5則是給標記擴充套件中定義的屬性Value1賦值。

小結

本文介紹了WPF的基礎概念標記擴充套件,並列舉了WPF框架內建了兩大類標記擴充套件。最後用一個不太有實際意義的簡單示例展示瞭如何自定義標記擴充套件。由於MarkupExtension並非派生自DependencyObject,因此不能直接定義依賴屬性,但可以透過定義一個依賴物件結合附加屬性的方式實現擴充套件標記屬性的繫結。

參考


  1. https://learn.microsoft.com/zh-cn/dotnet/desktop/xaml-services/escape-sequence-markup-extension ↩︎

  2. https://learn.microsoft.com/zh-cn/dotnet/desktop/xaml-services/types-for-primitives ↩︎

  3. https://learn.microsoft.com/zh-cn/dotnet/desktop/wpf/advanced/wpf-xaml-extensions?view=netframeworkdesktop-4.8 ↩︎

相關文章