マークアップ拡張機能と WPF XAML

2025-05-07

このトピックでは、XAML のマークアップ拡張の概念 (構文規則、目的、基になるクラスオブジェクトモデルなど) について説明します。マークアップ拡張は、XAML 言語と XAML サービスの .NET 実装の一般的な機能です。このトピックでは、WPF XAML で使用するためのマークアップ拡張機能について具体的に説明します。

XAML プロセッサとマークアップ拡張機能

一般に、XAML パーサーは、属性値をプリミティブに変換できるリテラル文字列として解釈するか、何らかの方法でオブジェクトに変換することができます。そのような手段の 1 つは、型コンバーターを参照する方法です。これについては、 TypeConverters と XAML に関するトピックで説明されています。ただし、異なる動作が必要なシナリオもあります。たとえば、XAML プロセッサは、属性の値がオブジェクトグラフ内の新しいオブジェクトになることがないように指示できます。代わりに、この属性は、グラフの別の部分で既に構築されているオブジェクトまたは静的オブジェクトへの参照を作成するオブジェクトグラフになります。もう 1 つのシナリオは、オブジェクトのコンストラクターに既定以外の引数を提供する構文を使用するように XAML プロセッサに指示できることです。これらは、マークアップ拡張機能がソリューションを提供できるシナリオの種類です。

基本的なマークアップ拡張構文

マークアップ拡張を実装して、属性使用法のプロパティ、プロパティ要素のプロパティ、またはその両方の値を提供できます。

属性値を指定するために使用する場合、XAML プロセッサに対してマークアップ拡張シーケンスを区別する構文は、波括弧 ({ と }) で囲むことです。マークアップ拡張の型は、開く波括弧のすぐ後にある文字列トークンによって識別されます。

プロパティ要素の構文で使用する場合、マークアップ拡張は、プロパティ要素値を提供するために使用される他の要素と視覚的に同じです。マークアップ拡張クラスを要素として参照する XAML 要素宣言は、山かっこ (<>) で囲まれています。

XAML-Defined マークアップ拡張機能

XAML の WPF 実装に固有ではなく、言語としての XAML の組み込みまたは機能の実装であるマークアップ拡張がいくつか存在します。これらのマークアップ拡張機能は、一般的な .NET Framework XAML サービスの一部として System.Xaml アセンブリに実装され、XAML 言語 XAML 名前空間内にあります。一般的なマークアップの使用に関しては、これらのマークアップ拡張は通常、使用法の x: プレフィックスによって識別できます。 MarkupExtension基本クラス (System.Xaml でも定義) は、XAML リーダーと XAML ライター (WPF XAML を含む) でサポートされるためにすべてのマークアップ拡張機能を使用する必要があるパターンを提供します。

x:Type は、名前付き型の Type オブジェクトを提供します。この機能は、スタイルとテンプレートで最も頻繁に使用されます。詳細については、「 x:Type Markup Extension」を参照してください。
x:Static は静的な値を生成します。値は、ターゲットプロパティの値の型ではなく、その型に評価できる値型のコードエンティティから取得されます。詳細については、「 x:Static Markup Extension」を参照してください。
x:Null は null をプロパティの値として指定し、属性またはプロパティ要素の値に使用できます。詳細については、「 x:Null マークアップ拡張」を参照してください。
x:Array は、WPF 基本要素とコントロールモデルによって提供されるコレクションのサポートが意図的に使用されない場合に、XAML 構文での一般的な配列の作成をサポートします。詳細については、「 x:Array Markup Extension」を参照してください。

注

x: プレフィックスは、XAML ファイルまたは運用環境のルート要素で、XAML 言語組み込みの一般的な XAML 名前空間マッピングに使用されます。たとえば、WPF アプリケーション用の Visual Studio テンプレートは、この x: マッピングを使用して XAML ファイルを開始します。独自の XAML 名前空間マッピングで別のプレフィックストークンを選択することもできますが、このドキュメントでは、WPF の既定の名前空間や特定のフレームワークに関連しないその他の XAML 名前空間ではなく、XAML 言語の XAML 名前空間の定義された部分であるエンティティを識別する手段として、既定の x: マッピングを想定しています。

WPF-Specific マークアップ拡張

WPF プログラミングで使用される最も一般的なマークアップ拡張機能は、リソース参照 (StaticResource と DynamicResource) をサポートするマークアップ拡張機能と、データバインディング (Binding) をサポートするマークアップ拡張機能です。

StaticResource は、既に定義されているリソースの値を置き換えることによって、プロパティの値を提供します。 StaticResource評価は最終的に XAML 読み込み時に行われ、実行時にオブジェクトグラフにアクセスすることはできません。詳細については、「 StaticResource Markup Extension」を参照してください。
DynamicResource は、その値をリソースへの実行時参照として遅延することによって、プロパティの値を提供します。動的リソース参照は、このようなリソースがアクセスされ、実行時にオブジェクトグラフにアクセスできるたびに新しい参照を強制します。このアクセスを取得するために、 DynamicResource の概念は、WPF プロパティシステムの依存関係プロパティと評価された式によってサポートされています。したがって、依存関係プロパティターゲットには DynamicResource のみを使用できます。詳細については、「 DynamicResource マークアップ拡張」を参照してください。
Binding は、実行時に親オブジェクトに適用されるデータコンテキストを使用して、プロパティのデータバインド値を提供します。このマークアップ拡張は、データバインディングを指定するための実質的なインライン構文を有効にするため、比較的複雑です。詳細については、「バインディングマークアップ拡張機能」を参照してください。
RelativeSource は、実行時オブジェクトツリー内で可能な複数のリレーションシップ間を移動できる Binding のソース情報を提供します。これにより、マルチユーステンプレートで作成されるバインディングや、周囲のオブジェクトツリーに関する完全な知識がなくてもコードで作成されるバインディングに特化したソーシングが提供されます。詳細については、「 RelativeSource MarkupExtension」を参照してください。
TemplateBinding を使用すると、コントロールテンプレートは、テンプレートを使用するクラスのオブジェクトモデル定義プロパティから取得されるテンプレート化されたプロパティの値を使用できます。つまり、テンプレート定義内のプロパティは、テンプレートが適用された後にのみ存在するコンテキストにアクセスできます。詳細については、「 TemplateBinding Markup Extension」を参照してください。 TemplateBindingの使用方法の詳細については、「ControlTemplates サンプルを使用したスタイル設定」を参照してください。
ColorConvertedBitmap では、比較的先進的な画像処理のシナリオがサポートされています。詳細については、「 ColorConvertedBitmap Markup Extension」を参照してください。
ComponentResourceKey および ThemeDictionary は、特にカスタムコントロールと共にパッケージ化されたリソースとテーマに対して、リソース参照の側面をサポートします。詳細については、「 ComponentResourceKey Markup Extension」、 ThemeDictionary Markup Extension、または Control Authoring Overview を参照してください。

*拡張クラス

一般的な XAML 言語と WPF 固有のマークアップ拡張の両方について、各マークアップ拡張機能の動作は、*Extensionから派生したMarkupExtension クラスを介して XAML プロセッサに識別され、ProvideValue メソッドの実装を提供します。各拡張機能のこのメソッドは、マークアップ拡張機能の評価時に返されるオブジェクトを提供します。通常、返されるオブジェクトは、マークアップ拡張機能に渡されるさまざまな文字列トークンに基づいて評価されます。

たとえば、 StaticResourceExtension クラスは、 ProvideValue 実装が要求されたオブジェクトを返すように、実際のリソース参照の表面実装を提供します。その特定の実装の入力は、その x:Keyによってリソースを検索するために使用される文字列です。既存のマークアップ拡張機能を使用している場合、この実装の詳細の多くは重要ではありません。

一部のマークアップ拡張では、文字列トークン引数が使用されません。これは、静的または一貫性のある値を返すか、返される必要がある値のコンテキストが、 serviceProvider パラメーターを介して渡されたサービスのいずれかを通じて使用できるためです。

*Extension名前付けパターンは、利便性と一貫性を保つためです。 XAML プロセッサがそのクラスをマークアップ拡張のサポートとして識別するために必要ではありません。コードベースに System.Xaml が含まれており、.NET Framework XAML サービスの実装を使用している限り、XAML マークアップ拡張機能として認識するために必要なのは、 MarkupExtension から派生し、構築構文をサポートすることにあります。 WPF では、*Extensionなど、Binding名前付けパターンに従わないマークアップ拡張機能を有効にするクラスを定義します。通常、この理由は、純粋なマークアップ拡張のサポートを超えるシナリオがクラスでサポートされるためです。 Bindingの場合、そのクラスは XAML とは関係のないシナリオで、オブジェクトのメソッドとプロパティへの実行時アクセスをサポートします。

初期化テキストの拡張クラスの解釈

マークアップ拡張名に続き、中かっこ内の文字列トークンは、次のいずれかの方法で XAML プロセッサによって解釈されます。

コンマは、常に個々のトークンの区切り記号または区切り記号を表します。
個々の区切られたトークンに等号が含まれていない場合、各トークンはコンストラクター引数として扱われます。各コンストラクターパラメーターは、そのシグネチャで想定される型として、およびそのシグネチャで想定される適切な順序で指定する必要があります。

注

XAML プロセッサは、ペアの数の引数数に一致するコンストラクターを呼び出す必要があります。このため、カスタムマークアップ拡張機能を実装する場合は、同じ引数数を持つ複数のコンストラクターを指定しないでください。同じパラメーター数を持つ複数のマークアップ拡張コンストラクターパスが存在する場合の XAML プロセッサの動作は定義されていませんが、この状況がマークアップ拡張型の定義に存在する場合は、XAML プロセッサが使用時に例外をスローすることが許可されることを予測する必要があります。
個々の区切りトークンに等号が含まれている場合、XAML プロセッサは最初にマークアップ拡張機能のパラメーターなしのコンストラクターを呼び出します。その後、各 name=value ペアは、マークアップ拡張機能に存在するプロパティ名と、そのプロパティに割り当てる値として解釈されます。
マークアップ拡張機能でコンストラクターの動作とプロパティ設定の動作の間に並列結果がある場合、使用する動作は関係ありません。複数の設定可能なプロパティを持つマークアップ拡張に対して プロパティ=値ペアを使用する方が一般的です。マークアップが意図的になり、コンストラクターパラメーターを誤って入れ替える可能性が低い場合に限られます。 (property=value のペアを指定する場合、これらのプロパティは任意の順序で指定できます)。また、マークアップ拡張機能が、その設定可能なプロパティの 1 つ 1 つを設定するコンストラクターパラメーターを提供する保証はありません。たとえば、Bindingはマークアップ拡張であり、=値形式で拡張を使用して設定できるプロパティが多数ありますが、Bindingはパラメーターなしのコンストラクターと、初期パスを設定するコンストラクターの 2 つのコンストラクターのみをサポートします。
リテラルコンマは、エスケープなしでマークアップ拡張機能に渡すことができません。

エスケープシーケンスとマークアップ拡張

XAML プロセッサでの属性処理では、マークアップ拡張シーケンスのインジケーターとして中かっこが使用されます。必要に応じて、空の中かっこペアを使用してエスケープシーケンスを入力し、リテラル中かっこの後にリテラル中かっこを入力することで、リテラル中かっこ文字属性値を生成することもできます。「エスケープシーケンス - マークアップ拡張{}」を参照してください。

XAML でのマークアップ拡張のネスト方法

複数のマークアップ拡張機能の入れ子がサポートされており、各マークアップ拡張機能は最初に最も深く評価されます。たとえば、次の使用方法を考えてみましょう。

<Setter Property="Background"
  Value="{DynamicResource {x:Static SystemColors.ControlBrushKey}}" />

この使用法では、 x:Static ステートメントが最初に評価され、文字列が返されます。その後、その文字列が DynamicResourceの引数として使用されます。

マークアップ拡張とプロパティ要素の構文

プロパティ要素の値を埋めるオブジェクト要素として使用する場合、マークアップ拡張クラスは、XAML で使用できる一般的な型指定されたオブジェクト要素と視覚的に区別できません。一般的なオブジェクト要素とマークアップ拡張の実際の違いは、マークアップ拡張が型指定された値に評価されるか、式として遅延されるということです。したがって、マークアップ拡張のプロパティ値の型エラーの可能性があるメカニズムは、他のプログラミングモデルでの遅延バインドプロパティの処理方法と同様に異なります。通常のオブジェクト要素は、XAML の解析時に設定されているターゲットプロパティに対する型の一致について評価されます。

ほとんどのマークアップ拡張は、プロパティ要素を埋めるためにオブジェクト要素構文で使用される場合、コンテンツやその他のプロパティ要素構文を含んでいません。したがって、オブジェクト要素タグを閉じ、子要素を指定しません。 XAML プロセッサによってオブジェクト要素が検出されるたびに、そのクラスのコンストラクターが呼び出され、解析された要素から作成されたオブジェクトがインスタンス化されます。マークアップ拡張クラスは変わりありません。マークアップ拡張をオブジェクト要素構文で使用できるようにする場合は、パラメーターなしのコンストラクターを指定する必要があります。一部の既存のマークアップ拡張には、有効な初期化のために指定する必要がある必須プロパティ値が少なくとも 1 つ含まれます。その場合、通常、そのプロパティ値はオブジェクト要素のプロパティ属性として指定されます。 XAML 名前空間 (x:) 言語機能と WPF XAML 拡張機能のリファレンスページでは、必要なプロパティ (および必要なプロパティの名前) を持つマークアップ拡張機能が示されます。参照ページでは、特定のマークアップ拡張に対してオブジェクト要素の構文または属性構文が許可されていない場合にも注意が必要です。注目すべきケースは x:Array Markup Extension です。これは、その配列の内容をコンテンツとしてタグ付け内で指定する必要があるため、属性構文をサポートできません。配列の内容は一般的なオブジェクトとして処理されるため、属性の既定の型コンバーターは使用できません。また、 x:Array Markup Extension には、 type パラメーターが必要です。