XAML 名前スコープ

[アーティクル]
07/13/2023

XAML 名前スコープ には、XAML で定義されたオブジェクトの名前とそれに対応するインスタンスとの関係が格納されます。この概念は、他のプログラミング言語やテクノロジで使われている用語 "名前スコープ" と広い意味で似ています。

XAML 名前スコープの定義方法

XAML 名前スコープ内で名前を使うと、最初に XAML で定義されたオブジェクトをユーザーコードで参照できます。 XAML を解析すると、内部的に、XAML 宣言で保持していた一部またはすべての関係を維持する一連のオブジェクトが作成されます。これらの関係が、作成されたオブジェクトの特定のオブジェクトプロパティとして保持されるか、プログラミングモデル API のユーティリティメソッドとして公開されます。

XAML 名前スコープ内の名前の最も一般的な用途は、オブジェクトインスタンスに対する直接参照です。これは、マークアップコンパイルパスを部分クラステンプレートに生成された InitializeComponent メソッドと組み合わせてプロジェクトビルドアクションとして使うことで、有効化されます。

FindName ユーティリティメソッドを実行時に使って、XAML マークアップで名前を定義されているオブジェクトへの参照を返すこともできます。

ビルドアクションと XAML の詳細

技術的には、XAML 自体はマークアップコンパイラパスを使います。この際、XAML と、コードビハインド用に定義した部分クラスがまとめてコンパイルされます。マークアップで定義された Name 属性または x:Name 属性を持つ各オブジェクト要素が、XAML と同名の内部フィールドを生成します。初期状態では、このフィールドは空です。続いて、クラスが InitializeComponent メソッドを生成します。このメソッドは、すべての XAML が読み込まれた後にのみ呼び出されます。 InitializeComponent ロジックにおいて、各内部フィールドには、名前文字列が等しいかどうかを評価した結果を表す FindName の戻り値が設定されます。このインフラストラクチャは、コンパイル後に Windows ランタイムアプリプロジェクトの /obj サブフォルダーに XAML ページごとに作成される ".g" (生成) ファイルで確認できます。リフレクションを実行した場合は、結果として作成されるアセンブリのメンバーとしてのフィールドや InitializeComponent メソッドの存在を確認することもできます。それ以外の場合は、インターフェイス言語の内容を調べます。

注特に Visual C++ コンポーネント拡張機能 (C++/CX) アプリの場合、x:Name 参照のバッキングフィールドが、XAML ファイルのルート要素に対して作成されません。 C++/CX のコードビハインドからルートオブジェクトを参照する必要がある場合は、他の API またはツリー走査を使ってください。たとえば、既知の名前付き子要素に対して FindName を呼び出した後、Parent を呼び出します。

XamlReader.Load を使った実行時におけるオブジェクトの作成

XAML は、初期の XAML ソース解析操作に対して同じように動作する XamlReader.Load メソッドの文字列入力としても使用できます。 XamlReader.Load は、実行時にオブジェクトの切断されたツリーを新規作成します。この切断されたツリーは、メインオブジェクトツリーのいずれかのポイントにアタッチできます。作成したオブジェクトツリーは、Children などのコンテンツプロパティコレクションに追加するか、オブジェクト値を受け取る他のプロパティを設定する (たとえば、Fill プロパティの値に新しい ImageBrush を読み込む) ことで、明示的に接続する必要があります。

XamlReader.Load が XAML 名前スコープに与える影響

XamlReader.Load によって作成された新しいオブジェクトツリーで定義される暫定的な XAML 名前スコープは、指定された XAML で定義名が一意であるかどうかを評価します。指定された XAML 内の名前がこの時点で内部的に一意でない場合、XamlReader.Load によって例外がスローされます。切断されたオブジェクトツリーがメインのアプリオブジェクトツリーに接続されている場合、切断されたオブジェクトツリーの XAML 名前スコープは、メインのアプリ XAML 名前スコープには結合されません。ツリーの接続後、アプリのオブジェクトツリーは結合されていますが、そのツリーの XAML 名前スコープは分離されています。オブジェクト間の接続ポイントでは、分岐が発生します。ここで、XamlReader.Load の呼び出しによって返される値をプロパティに設定します。

切断された異なる XAML 名前スコープを持つことに伴う問題は、マネージオブジェクトの直接参照と同様に、FindName メソッドの呼び出しが、結合された XAML 名前スコープでは動作しなくなることです。代わりに、FindName の呼び出しの対象となった特定のオブジェクトがスコープを意味し、そのスコープは呼び出し元オブジェクトが存在する XAML 名前スコープになります。マネージオブジェクトの直接参照では、スコープは、コードが存在するクラスによって暗黙的に指定されます。一般に、アプリコンテンツの "ページ" における実行時の対話に使うコードビハインドは、ルート "ページ" をサポートする部分クラスに存在するため、XAML 名前スコープはルート XAML 名前スコープになります。

ルート XAML 名前スコープで指定したオブジェクトを取得するために FindName を呼び出した場合、XamlReader.Load によって作成された、異なる XAML 名前スコープのオブジェクトは検索されません。逆に、異なる XAML 名前スコープの外部で取得したオブジェクトから FindName を呼び出した場合は、ルート XAML 名前スコープで指定したオブジェクトは検索されません。

異なる XAML 名前スコープの問題によって影響を受けるのは、FindName 呼び出しを使って XAML 名前スコープで名前に基づいてオブジェクトを検索する処理だけです。

異なる XAML 名前スコープに定義されているオブジェクトを参照するには、次のような手法を使用できます。

Parent や、オブジェクトツリー構造内に存在することが判明しているコレクションプロパティ (Panel.Children によって返されるコレクションなど) を使って、分離されたステップでツリー全体を移動します。
異なる XAML 名前スコープから呼び出していて、ルート XAML 名前スコープを対象とする必要がある場合は、現在表示されているメインウィンドウへの参照を取得すると簡単です。 Window.Current.Contentを呼び出す 1 行のコードを使って、現在のアプリウィンドウからの表示ルート (ルート XAML 要素、"コンテンツソース" とも呼ばれます) を取得できます。次に FrameworkElement にキャストし、このスコープから FindName を呼び出すことができます。
ルート XAML 名前スコープから呼び出していて、異なる XAML 名前スコープ内のオブジェクトを対象とする必要がある場合は、XamlReader.Load から返されてメインオブジェクトツリーに追加されたオブジェクトへの参照を、あらかじめコードに記述して保持しておくことをお勧めします。これにより、このオブジェクトが、異なる XAML 名前スコープ内で FindName を呼び出すための有効なオブジェクトになります。このオブジェクトはグローバル変数として保持できるほか、メソッドのパラメーターを使って渡すこともできます。
ビジュアルツリーを走査することにより、名前と XAML 名前スコープの考慮事項を完全に回避できます。 VisualTreeHelper API を使うと、位置とインデックスだけを基に、親オブジェクトと子コレクションの観点からビジュアルツリーを走査できます。

テンプレートにおける XAML 名前スコープ

XAML のテンプレートを使うと、コンテンツを簡単に再利用および再適用できます。ただし、テンプレートには、テンプレートレベルで定義された名前を持つ要素も含まれている可能性があります。その同じテンプレートが 1 ページで複数回使用される可能性があります。このため、テンプレートに、適用先のページに依存しない独自の XAML 名前スコープを定義します。次の例について考えます。

<Page
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"  >
  <Page.Resources>
    <ControlTemplate x:Key="MyTemplate">
      ....
      <TextBlock x:Name="MyTextBlock" />
    </ControlTemplate>
  </Page.Resources>
  <StackPanel>
    <SomeControl Template="{StaticResource MyTemplate}" />
    <SomeControl Template="{StaticResource MyTemplate}" />
  </StackPanel>
</Page>

ここでは、同一のテンプレートを 2 つの異なるコントロールに適用しています。これらのテンプレートがそれぞれ異なる XAML 名前スコープを持たなければ、テンプレート内で使われている "MyTextBlock" という名前により、名前の競合が発生することになります。テンプレートのインスタンス化ごとに独自の XAML 名前スコープがあるため、この例では、インスタンス化されるテンプレートの各 XAML 名前スコープには、名前が 1 つだけ含まれます。ただし、ルート XAML 名前スコープには、どちらのテンプレートの名前も含まれていません。

XAML 名前スコープが複数存在するため、テンプレートが適用されるページのスコープからテンプレート内の指定要素を検索するには、別の手法が必要になります。オブジェクトツリー内のオブジェクトに対して FindName を呼び出すのではなく、まずテンプレートが適用されているオブジェクトを取得し、その後で GetTemplateChild を呼び出します。コントロールの作成者が生成している規則で、適用されたテンプレートの特定の指定要素を、コントロール自体によって定義される動作の対象とする場合は、コントロール実装コードから GetTemplateChild メソッドを使用できます。 GetTemplateChild メソッドはプロテクトされているため、コントロールの作成者のみがアクセスできます。また、パーツやテンプレートパーツに名前を付け、これらをコントロールクラスに適用される属性値として報告するために、コントロールの作成者が従う規則があります。この方法を使うと、異なるテンプレートを適用しようとしているコントロールユーザーは重要なパーツ名を検出できるようになります。コントロールの機能を維持するには、名前付きパーツをそのテンプレートに置き換える必要があります。

XAML 名前スコープ