ResourceContext Класс

Определение

Пространство имен:

Windows.ApplicationModel.Resources.Core

Инкапсулирует все факторы (ResourceQualifiers), которые могут повлиять на выбор ресурсов.

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 . Примечание Конструктор ResourceContext может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте GetForCurrentView и Clone.

Свойства

Languages	Возвращает или задает квалификатор языка для данного контекста.
QualifierValues	Возвращает доступную для записи отслеживаемую карту всех поддерживаемых квалификаторов, индексированных по имени.

Методы

Clone()	Создает клон этого ResourceContext с идентичными квалификаторами.
CreateMatchingContext(IIterable<ResourceQualifier>)	Создает новый объект ResourceContext , соответствующий предоставленному набору квалификаторов. Примечание CreateMatchingContext может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте ResourceContext.GetForCurrentView.OverrideToMatch.
GetForCurrentView()	Возвращает resourceContext по умолчанию, связанный с текущим представлением для текущего запущенного приложения.
GetForUIContext(UIContext)	Возвращает resourceContext по умолчанию, связанный с указанным UIContext для текущего запущенного приложения.
GetForViewIndependentUse()	Возвращает resourceContext по умолчанию, не связанный ни с каким представлением.
OverrideToMatch(IIterable<ResourceQualifier>)	Переопределяет значения квалификатора, предоставленные этим контекстом, в соответствии с указанным списком разрешенных resourceQualifiers. Как правило, разрешенные resourceQualifierсвязаны с ресурсом, который был выполнен ранее.
Reset()	Сбрасывает переопределенные значения для всех квалификаторов в заданном экземпляре ResourceContext .
Reset(IIterable<String>)	Сбрасывает переопределенные значения для указанных квалификаторов в заданном экземпляре ResourceContext .
ResetGlobalQualifierValues()	Удаляет все переопределения квалификатора из контекстов по умолчанию для всех представлений в приложении.
ResetGlobalQualifierValues(IIterable<String>)	Удаляет переопределения квалификаторов для указанных квалификаторов из контекстов по умолчанию всех представлений в приложении.
SetGlobalQualifierValue(String, String)	Применяет переопределение одного значения квалификатора к контекстам по умолчанию всех представлений для текущего приложения.
SetGlobalQualifierValue(String, String, ResourceQualifierPersistence)	Применяет одно значение квалификатора для переопределения к контекстам по умолчанию всех представлений для текущего приложения и задает сохраняемость переопределения.

См. также раздел

• ResourceQualifier
• Пример ресурсов и локализации приложения