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

  • [アーティクル]

ここでは XAML のマークアップ拡張の概念について、構文規則、目的、その基になるクラス オブジェクト モデルなどを説明します。 マークアップ拡張は、XAML 言語、および XAML サービスの .NET 実装の一般的な機能です。 ここでは、WPF XAML で使用するマークアップ拡張について特に詳しく説明します。

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

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

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

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

属性値を提供するために使用する場合、XAML プロセッサでマークアップ拡張シーケンスを区別する構文は、左中かっこと右中かっこ ({ と }) です。 その後、マークアップ拡張の種類は、左中かっこの直後の文字列トークンによって識別されます。

プロパティ要素構文で使用する場合、マークアップ拡張は、プロパティ要素値の指定に使用するその他の要素と表示上は同じになります。つまり、山かっこ (<>) で囲まれた、マークアップ拡張クラスを要素として参照する XAML 要素宣言になります。

XAML で定義されたマークアップ拡張機能

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

  • x:Type は、名前を指定した型の Type オブジェクトを提供します。 この機能は、スタイルとテンプレートで最もよく使用されます。 詳細については、「x:Type マークアップ拡張機能」を参照してください。

  • x:Static は、静的な値を生成します。 この値は、直接的にはターゲット プロパティの値の型ではなくても、その型に評価することができる値型コード エンティティから生成されます。 詳細については、「x:Static マークアップ拡張機能」を参照してください。

  • x:Null は、プロパティの値として null を指定し、属性またはプロパティ要素の値として使用できます。 詳細については、「x:Null マークアップ拡張機能」を参照してください。

  • x:Array は、XAML 構文での一般的な配列の作成をサポートします。WPF 基本要素とコントロール モデルで提供されているコレクションのサポートをあえて使用しない場合に使用します。 詳細については、「x:Array Markup Extension」を参照してください。

注意

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

WPF 固有のマークアップ拡張

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

  • StaticResource は、既に定義されているリソースの値を代入することによって、プロパティの値を提供します。 StaticResource の評価は、最終的には XAML の読み込み時に行われます。実行時にオブジェクト グラフにアクセスすることはできません。 詳細については、「StaticResource のマークアップ拡張機能」を参照してください。

  • DynamicResource は、プロパティの値がリソースに対する実行時参照になるように延期することによって、プロパティの値を提供します。 動的リソース参照では、そのようなリソースがアクセスされるたびに、強制的に新しいルックアップが行われます。実行時にオブジェクト グラフにアクセスすることもできます。 このようなアクセスを実現するために、DynamicResource の概念が、WPF プロパティ システムの依存関係プロパティと、評価された式によってサポートされます。 したがって、DynamicResource は、依存関係プロパティ ターゲットにのみ使用できます。 詳細については、「DynamicResource のマークアップ拡張機能」を参照してください。

  • Binding は、実行時に親オブジェクトに適用されるデータ コンテキストを使用して、データ バインディングされた値をプロパティに提供します。 このマークアップ拡張は、データ バインディングを指定するためにかなりの量のインライン構文を使用できるため、比較的複雑です。 詳細については、「バインディングのマークアップ拡張機能」を参照してください。

  • RelativeSource は、実行時のオブジェクト ツリーに存在する可能性のあるいくつかの関係を移動できる Binding に、ソース情報を指定します。 これにより、周囲のオブジェクト ツリーに関する完全な知識がなくても、多目的のテンプレートで作成されるバインド、またはコードで作成されるバインドに対して、特殊なソースを指定することができます。 詳細については、「RelativeSource のマークアップ拡張機能」を参照してください。

  • TemplateBinding により、コントロール テンプレートがテンプレート プロパティの値を使用できるようになります。それらの値は、テンプレートを使用するクラスのオブジェクト モデルで定義されたプロパティから取られます。 つまり、テンプレート定義内のプロパティが、テンプレートを適用する場合にのみ存在するコンテキストにアクセスできます。 詳細については、「TemplateBinding のマークアップ拡張機能」を参照してください。 TemplateBinding の実際の使用方法の詳細については、「ControlTemplate を使用したスタイル設定のサンプル」を参照してください。

  • ColorConvertedBitmap は、比較的高度なイメージング シナリオをサポートします。 詳細については、「ColorConvertedBitmap のマークアップ拡張機能」を参照してください。

  • ComponentResourceKey と ThemeDictionary は、リソースのルックアップをサポートします。特に、カスタム コントロールでパッケージ化されるリソースとテーマを対象としています。 詳細については、「ComponentResourceKey マークアップ拡張機能」、「ThemeDictionary のマークアップ拡張機能」、「コントロールの作成の概要」を参照してください。

*Extension クラス

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

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

一部のマークアップ拡張では、文字列トークン引数は使用されません。 これは、それらのマークアップ拡張では静的な値や一貫した値が返されるため、または返されるべき値のコンテキストが serviceProvider パラメーターを介して渡されるサービスの 1 つから得られるためです。

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

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

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

  • コンマは常に個別のトークンの区切りまたは区切り記号を表します。

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

    注意

    XAML プロセッサは、ペアの数の引数の数に一致するコンストラクターを呼び出す必要があります。 このため、カスタム マークアップ拡張を実装する場合は、複数のコンストラクターに同じ引数の数を指定しないでください。 パラメーターの数が同じマークアップ拡張コンストラクター パスが複数存在する場合の XAML プロセッサの動作は、定義されていません。ただし、マークアップ拡張の型定義がこのような状態になっていると、使用方法に関する例外が XAML プロセッサからスローされる可能性があることを想定しておく必要があります。

  • 個別の区切られたトークンに等号が含まれている場合、XAML プロセッサは最初にマークアップ拡張のパラメーターなしのコンストラクターを呼び出します。 その後、各 "名前=値" のペアは、マークアップ拡張に存在するプロパティ名、およびそのプロパティに割り当てる値として解釈されます。

  • マークアップ拡張でコンストラクターの動作とプロパティの設定の動作の結果が類似している場合は、どちらの動作を使用しても問題はありません。 複数の設定可能なプロパティを持つマークアップ拡張では、"プロパティ=値" のペアの方がよく使用されます。単に、その方がマークアップの意図が明確になり、コンストラクター パラメーターを間違って入れ替える可能性も低いためです。 ("プロパティ=値" のペアを指定すると、それらのプロパティは任意の順序になります。)また、設定可能なプロパティのすべてを設定するコンストラクター パラメーターがマークアップ拡張によって提供されるという保証はありません。 たとえば、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 マークアップ拡張です。このマークアップ拡張では、配列の内容をタグ設定の内側にコンテンツとして指定する必要があるため、属性構文をサポートできません。 配列の内容は一般的なオブジェクトとして扱われるため、属性に対する既定の型コンバーターは使用できません。 また、x:Array マークアップ拡張には type パラメーターが必要です。

関連項目