ResourceContext クラス

定義

名前空間:

Windows.ApplicationModel.Resources.Core

リソースの選択に影響を与える可能性があるすべての要因 (ResourceQualifier) をカプセル化します。

public ref class ResourceContext sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class ResourceContext final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class ResourceContext

function ResourceContext()

Public NotInheritable Class ResourceContext

継承

Object Platform::Object IInspectable ResourceContext

属性

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

デバイス ファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

この例は、 アプリケーション リソースとローカライズ サンプルのシナリオ 12 に基づいています。 完全なソリューションについては、サンプルを参照してください。

private async void Scenario12Button_Show_Click(object sender, RoutedEventArgs e)
{
    // Two coding patterns will be used:
    //   1. Get a ResourceContext on the UI thread using GetForCurrentView and pass 
    //      to the non-UI thread
    //   2. Get a ResourceContext on the non-UI thread using GetForViewIndependentUse
    //
    // Two analogous patterns could be used for ResourceLoader instead of ResourceContext.

    // pattern 1: get a ResourceContext for the UI thread
    ResourceContext defaultContextForUiThread = ResourceContext.GetForCurrentView();

    // pattern 2: we'll create a view-independent context in the non-UI worker thread

    // We need some things in order to display results in the UI (doing that
    // for purposes of this sample, to show that work was actually done in the
    // worker thread):
    List<string> uiDependentResourceList = new List<string>();
    List<string> uiIndependentResourceList = new List<string>();

    // use a worker thread for the heavy lifting so the UI isn't blocked
    await Windows.System.Threading.ThreadPool.RunAsync(
        (source) =>
        {
            ResourceMap stringResourceMap = ResourceManager.Current.MainResourceMap.GetSubtree("Resources");

            // pattern 1: the defaultContextForUiThread variable was created above and is visible here

            // pattern 2: get a view-independent ResourceContext
            ResourceContext defaultViewIndependentResourceContext = ResourceContext.GetForViewIndependentUse();

            // NOTE: The ResourceContext obtained using GetForViewIndependentUse() has no scale qualifier
            // value set. If this ResourceContext is used in its default state to retrieve a resource, that 
            // will work provided that the resource does not have any scale-qualified variants. But if the
            // resource has any scale-qualified variants, then that will fail at runtime.
            //
            // A scale qualifier value on this ResourceContext can be set programmatically. If that is done,
            // then the ResourceContext can be used to retrieve a resource that has scale-qualified variants.
            // But if the scale qualifier is reset (e.g., using the ResourceContext.Reset() method), then
            // it will return to the default state with no scale qualifier value set, and cannot be used
            // to retrieve any resource that has scale-qualified variants.

            // simulate processing a number of items
            // just using a single string resource: that's sufficient to demonstrate 
            for (var i = 0; i < 4; i++)
            {
                // pattern 1: use the ResourceContext from the UI thread
                string listItem1 = stringResourceMap.GetValue("string1", defaultContextForUiThread).ValueAsString;
                uiDependentResourceList.Add(listItem1);

                // pattern 2: use the view-independent ResourceContext
                string listItem2 = stringResourceMap.GetValue("string1", defaultViewIndependentResourceContext).ValueAsString;
                uiIndependentResourceList.Add(listItem2);
            }
        });

    // Display the results in one go. (A more finessed design might add results
    // in the UI asynchronously, but that goes beyond what this sample is 
    // demonstrating.)
    ViewDependentResourcesList.ItemsSource = uiDependentResourceList;
    ViewIndependentResourcesList.ItemsSource = uiIndependentResourceList;
}

void Scenario12::Scenario12Button_Show_Click(Platform::Object^ sender, Windows::UI::Xaml::RoutedEventArgs^ e)
{
    // Two coding patterns will be used:
    //   1. Get a ResourceContext on the UI thread using GetForCurrentView and pass 
    //      to the non-UI thread
    //   2. Get a ResourceContext on the non-UI thread using GetForViewIndependentUse
    //
    // Two analogous patterns could be used for ResourceLoader instead of ResourceContext.

    // pattern 1: get a ResourceContext for the UI thread
    ResourceContext^ defaultContextForUiThread = ResourceContext::GetForCurrentView();

    // pattern 2: we'll create a view-independent context in the non-UI worker thread

    // We need some things in order to display results in the UI (doing that
    // for purposes of this sample, to show that work was actually done in the
    // worker thread): a pair of vectors to capture data, and a pair of variable 
    // references to the controls where the results will be displayed (needed to
    // pass to the .then lambda).
    Platform::Collections::Vector<Platform::String^>^ uiDependentResourceItems = ref new Platform::Collections::Vector<Platform::String^>();
    Platform::Collections::Vector<Platform::String^>^ uiIndependentResourceItems = ref new Platform::Collections::Vector<Platform::String^>();
    ItemsControl^ viewDependentListControl = ViewDependentResourcesList;
    ItemsControl^ viewIndependentListControl = ViewIndependentResourcesList;


    // use a worker thread for the heavy lifting so the UI isn't blocked
    concurrency::create_task(
        Windows::System::Threading::ThreadPool::RunAsync(
            ref new Windows::System::Threading::WorkItemHandler(
            [defaultContextForUiThread, uiDependentResourceItems, uiIndependentResourceItems](Windows::Foundation::IAsyncAction^ /*action*/)
        {
            // This is happening asynchronously on a background worker thread,
            // not on the UI thread.
            ResourceMap^ stringResourceMap = ResourceManager::Current->MainResourceMap->GetSubtree("Resources");

            // coding pattern 1: the defaultContextForUiThread variable was created above and has been captured to use here

            // coding pattern 2: get a view-independent ResourceContext
            ResourceContext^ defaultViewIndependentResourceContext = ResourceContext::GetForViewIndependentUse();

            // NOTE: The ResourceContext obtained using GetForViewIndependentUse() has no scale qualifier
            // value set. If this ResourceContext is used in its default state to retrieve a resource, that 
            // will work provided that the resource does not have any scale-qualified variants. But if the
            // resource has any scale-qualified variants, then that will fail at runtime.
            //
            // A scale qualifier value on this ResourceContext can be set programmatically. If that is done,
            // then the ResourceContext can be used to retrieve a resource that has scale-qualified variants.
            // But if the scale qualifier is reset (e.g., using the ResourceContext::Reset() method), then
            // it will return to the default state with no scale qualifier value set, and cannot be used
            // to retrieve any resource that has scale-qualified variants.

            // simulate processing a number of items
            // just using a single string resource: that's sufficient to demonstrate 
            for (auto i = 0; i < 4; i++)
            {
                // pattern 1: use the ResourceContext from the UI thread
                Platform::String^ item1 = stringResourceMap->GetValue("string1", defaultContextForUiThread)->ValueAsString;
                uiDependentResourceItems->Append(item1);

                // pattern 2: use the view-independent ResourceContext
                Platform::String^ item2 = stringResourceMap->GetValue("string1", defaultViewIndependentResourceContext)->ValueAsString;
                uiIndependentResourceItems->Append(item2);
            }
        }))
    ).then([uiDependentResourceItems, uiIndependentResourceItems, viewDependentListControl, viewIndependentListControl]
    {
        // After the async work is complete, this will execute on the UI thread.

        // Display the results in one go. (A more finessed design might add results
        // in the UI asynchronously, but that goes beyond what this sample is 
        // demonstrating.)
        viewDependentListControl->ItemsSource = uiDependentResourceItems;
        viewIndependentListControl->ItemsSource = uiIndependentResourceItems;
    });
}

注釈

リソースはスケーリングの影響を受ける可能性があり、アプリが所有する異なるビューは、異なるスケールを使用する可能性のあるさまざまなディスプレイ デバイスに同時に表示できます。 そのため、ResourceContext は通常、特定のビューに関連付けられているので、 GetForCurrentView を使用して取得する必要があります。 (ビューに依存しない ResourceContext は GetForViewIndependentUse を使用して取得できますが、ビューに関連付けられていない ResourceContext で呼び出された場合、スケールに依存する機能は失敗します。

コンストラクターを使用して ResourceContext のインスタンスを作成しないでください。これは非推奨であり、今後のリリースでは削除される可能性があるためです。

特に明記されていない限り、このクラスのメソッドは任意のスレッドで呼び出すことができます。

バージョン履歴

Windows のバージョン	SDK バージョン	追加された値
1903	18362	GetForUIContext

コンストラクター

ResourceContext()

複製された ResourceContext オブジェクトを作成します。 Note ResourceContext コンストラクターは、Windows 8.1後のリリースで変更または使用できない場合があります。 代わりに、 GetForCurrentView と Clone を使用 します。

プロパティ

Languages	このコンテキストの言語修飾子を取得または設定します。
QualifierValues	名前でインデックスが付いた、サポートされているすべての修飾子の書き込み可能で監視可能なマップを取得します。

メソッド

Clone()	同じ修飾子を使用して、この ResourceContext の複製を作成します。
CreateMatchingContext(IIterable<ResourceQualifier>)	指定された修飾子のセットと一致する新しい ResourceContext を作成します。 Note createMatchingContext は、Windows 8.1後にリリースで変更または使用できない場合があります。 代わりに、 ResourceContext.GetForCurrentView.OverrideToMatch を使用します。
GetForCurrentView()	現在実行中のアプリケーションの現在のビューに関連付けられている既定の ResourceContext を取得します。
GetForUIContext(UIContext)	現在実行中のアプリケーションの指定した UIContext に関連付けられている既定の ResourceContext を取得します。
GetForViewIndependentUse()	ビューに関連付けられていない既定 の ResourceContext を 取得します。
OverrideToMatch(IIterable<ResourceQualifier>)	解決された ResourceQualifierの指定されたリストと一致するように、このコンテキストによって指定された修飾子の値をオーバーライドします。 通常、解決された ResourceQualifierは、前に検索されたリソースに関連付けられます。
Reset()	指定された ResourceContext インスタンス上のすべての修飾子のオーバーライドされた値をリセットします。
Reset(IIterable<String>)	指定された ResourceContext インスタンスで指定された修飾子のオーバーライドされた値をリセットします。
ResetGlobalQualifierValues()	アプリ全体のすべてのビューの既定のコンテキストから修飾子のオーバーライドを削除します。
ResetGlobalQualifierValues(IIterable<String>)	指定した修飾子の修飾子のオーバーライドを、アプリ全体のすべてのビューの既定のコンテキストから削除します。
SetGlobalQualifierValue(String, String)	現在のアプリのすべてのビューの既定のコンテキストに 1 つの修飾子値オーバーライドを適用します。
SetGlobalQualifierValue(String, String, ResourceQualifierPersistence)	現在のアプリのすべてのビューの既定のコンテキストに単一の修飾子値オーバーライドを適用し、オーバーライドの永続化を指定します。

こちらもご覧ください

• ResourceQualifier
• アプリ リソースとローカライズのサンプル