{StaticResource} マークアップ拡張

[アーティクル]
07/05/2024

既に定義されているリソースへの参照を評価することによって、任意の XAML 属性の値を提供します。リソースは ResourceDictionary で定義され、 StaticResource 使用状況は ResourceDictionary 内のそのリソースのキーを参照します。

XAML 属性の使用方法

<object property="{StaticResource key}" .../>

XAML 値

項目	説明
キー	要求されたリソースのキー。このキーは、最初に ResourceDictionary によって割り当てられます。リソースキーは、XamlName 文法で定義されている任意の文字列の可能性があります。

解説

StaticResource は、XAML リソースディクショナリ内の他の場所で定義されている XAML 属性の値を取得するための手法です。値は、複数のプロパティ値によって共有されることを意図しているか、XAML リソースディクショナリが XAML パッケージ化または要素化の手法として使用されるため、リソースディクショナリに配置される場合があります。 XAML パッケージ化手法の例として、コントロールのテーマディクショナリがあります。もう 1 つの例として、リソースフォールバックに使用されるマージされたリソースディクショナリがあります。

StaticResource は、要求されたリソースのキーを指定する 1 つの引数を受け取ります。リソースキーは常に XAML の文字列Windows ランタイム。リソースキーの最初の指定方法の詳細については、「 x:Key 属性」を参照してください。

StaticResourceがリソースディクショナリ内の項目に解決する規則については、このトピックでは説明しません。これは、参照とリソースの両方がテンプレートに存在するかどうか、マージされたリソースディクショナリが使用されているかどうかなどによって異なります。リソースを定義し、サンプルコードを含む ResourceDictionary を適切に使用する方法の詳細については、「 ResourceDictionary および XAML リソース参照を参照してください。

重要 StaticResource は、XAML ファイルの中で辞書的に定義されているリソースへの前方参照を行うことはできません。この操作はサポートされていません。前方参照が失敗しない場合でも、前方参照を作成しようとするとパフォーマンスが低下します。最適な結果を得るには、前方参照が回避されるようにリソースディクショナリの構成を調整します。

解決できないキーに StaticResource を指定しようとすると、実行時に XAML 解析例外がスローされます。デザインツールでは、警告やエラーが表示される場合もあります。

Windows ランタイム XAML プロセッサの実装では、StaticResource 機能のバッキングクラス表現はありません。 StaticResource は XAML でのみ使用できます。コードで最も近いのは、 ResourceDictionary のコレクション API を使用することです。たとえば、 Contains または TryGetValue を呼び出します。

{ThemeResource} マークアップ拡張は、別の場所にある名前付きリソースを参照する同様のマークアップ拡張機能です。違いは、{ThemeResource} マークアップ拡張機能には、アクティブなシステムテーマに応じて異なるリソースを返す機能があるということです。詳細については、 {ThemeResource} マークアップ拡張を参照してください。

StaticResource はマークアップ拡張機能です。一般にマークアップ拡張機能を実装するのは、属性値をリテラル値やハンドラー名以外にエスケープする要件が存在し、その要件の適用範囲がグローバルで、特定の型やプロパティに型コンバーターを適用するだけにとどまらない場合です。 XAML のすべてのマークアップ拡張では、それぞれの属性構文で "{" と "}" の文字を使います。これは規約であり、これに従って XAML プロセッサは、マークアップ拡張で属性を処理する必要があることを認識します。

{StaticResource} の使用例

この例の XAML は、 XAML データバインディングサンプルから取得。

<StackPanel Margin="5">
    <!-- Add converter as a resource to reference it from a Binding. --> 
    <StackPanel.Resources>
        <local:S2Formatter x:Key="GradeConverter"/>
    </StackPanel.Resources>
    <TextBlock Style="{StaticResource BasicTextStyle}" Text="Percent grade:" Margin="5" />
    <Slider x:Name="sliderValueConverter" Minimum="1" Maximum="100" Value="70" Margin="5"/>
    <TextBlock Style="{StaticResource BasicTextStyle}" Text="Letter grade:" Margin="5"/>
    <TextBox x:Name="tbValueConverterDataBound"
      Text="{Binding ElementName=sliderValueConverter, Path=Value, Mode=OneWay,  
        Converter={StaticResource GradeConverter}}" Margin="5" Width="150"/> 
</StackPanel>

この特定の例では、カスタムクラスによってサポートされるオブジェクトを作成し、それをリソースとして ResourceDictionary に作成します。有効なリソースにするには、この local:S2Formatter 要素にも x:Key 属性値が必要です。属性の値は "GradeConverter" に設定されます。

その後、リソースは XAML に少しだけ先に要求され、ここで {StaticResource GradeConverter}表示されます。

{StaticResource} マークアップ拡張機能の使用法で、別のマークアップ拡張機能のプロパティ {Binding} マークアップ拡張がどのように設定されているかに注意してください。そのため、ここには 2 つの入れ子になったマークアップ拡張機能の使用法があります。最初に内部のリソースが取得され、値として使用できるように、内部の 1 つが最初に評価されます。この同じ例は、{Binding} マークアップ拡張にも示されています。