ResourceManager ResourceManager ResourceManager ResourceManager ResourceManager Class

Definition

Provides access to application resource maps and more advanced resource functionality.

public : sealed class ResourceManager : IResourceManager, IResourceManager2
struct winrt::Windows::ApplicationModel::Resources::Core::ResourceManager : IResourceManager, IResourceManager2
public sealed class ResourceManager : IResourceManager, IResourceManager2
Public NotInheritable Class ResourceManager Implements IResourceManager, IResourceManager2
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

This example is based on scenario 13 of the Application resources and localization sample. See the sample for the more complete solution.

// Create a ResourceContext.
var resourceContext = new Windows.ApplicationModel.Resources.Core.ResourceContext();

// Set the specific context for lookup of resources.
var qualifierValues = resourceContext.qualifierValues;
qualifierValues["language"] = "en-US";
qualifierValues["contrast"] = "standard";
qualifierValues["scale"] = "140";
qualifierValues["homeregion"] = "021"; // Northern America

// Resources actually reside within Scenario13 Resource Map.
var resourceIds = [
    '/Scenario13/languageOnly',
    '/Scenario13/scaleOnly',
    '/Scenario13/contrastOnly',
    '/Scenario13/homeregionOnly',
    '/Scenario13/multiDimensional',
];

var output = { str: "" };
resourceIds.forEach(function (resourceId) {
    renderNamedResource(resourceId, resourceContext, output);
});

function renderNamedResource(resourceId, resourceContext, output) {
    output.str += "Resource ID " + resourceId + ":\n";
    // Lookup the resource in the mainResourceMap (the one for this package).
    var namedResource = Windows.ApplicationModel.Resources.Core.ResourceManager.current.mainResourceMap.lookup(resourceId);

    // Return a ResourceCandidateVectorView of all possible resources candidates
    // resolved against the context in order of appropriateness.
    var resourceCandidates = namedResource.resolveAll(resourceContext);

    resourceCandidates.forEach(function (candidate, index) {
        renderCandidate(candidate, index, output);
    });
    output.str += "\n";
}

function renderCandidate(candidate, index, output) {
    // Get all the various qualifiers for the candidate (such as language, scale, contrast).
    candidate.qualifiers.forEach(function (qualifier) {
        output.str += "qualifierName: " + qualifier.qualifierName + "\n";
        output.str += "qualifierValue: " + qualifier.qualifierValue + "\n";
        output.str += "isDefault: ";
        output.str += (qualifier.isDefault) ? "true\n" : "false\n";
        output.str += "isMatch: ";
        output.str += (qualifier.isMatch) ? "true\n" : "false\n";
        output.str += "score: " + qualifier.score + "\n";
        output.str += "\n";
    });
}

Properties

AllResourceMaps AllResourceMaps AllResourceMaps AllResourceMaps AllResourceMaps

Gets a map of ResourceMap objects typically associated with the app packages, indexed by package name.

Current Current Current Current Current

Gets the ResourceManager for the currently running application.

DefaultContext DefaultContext DefaultContext DefaultContext DefaultContext

Note

DefaultContext may be altered or unavailable for releases after Windows 8.1. Instead, use ResourceContext.GetForCurrentView.

Gets the default ResourceContext for the currently running application. Unless explicitly overridden, the default ResourceContext is used to determine the most appropriate representation of any given named resource.

MainResourceMap MainResourceMap MainResourceMap MainResourceMap MainResourceMap

Gets the ResourceMap that is associated with the main package of the currently running application.

Methods

GetAllNamedResourcesForPackage(String, ResourceLayoutInfo) GetAllNamedResourcesForPackage(String, ResourceLayoutInfo) GetAllNamedResourcesForPackage(String, ResourceLayoutInfo) GetAllNamedResourcesForPackage(String, ResourceLayoutInfo) GetAllNamedResourcesForPackage(String, ResourceLayoutInfo)

Gets a list of all named resources for an app package.

GetAllSubtreesForPackage(String, ResourceLayoutInfo) GetAllSubtreesForPackage(String, ResourceLayoutInfo) GetAllSubtreesForPackage(String, ResourceLayoutInfo) GetAllSubtreesForPackage(String, ResourceLayoutInfo) GetAllSubtreesForPackage(String, ResourceLayoutInfo)

Gets a list of all collections of resource subtrees for an app package.

IsResourceReference(String) IsResourceReference(String) IsResourceReference(String) IsResourceReference(String) IsResourceReference(String)

Determines whether a supplied string matches the resource reference format (an ms-resource string URI identifier).

LoadPriFiles(IIterable<IStorageFile>) LoadPriFiles(IIterable<IStorageFile>) LoadPriFiles(IIterable<IStorageFile>) LoadPriFiles(IIterable<IStorageFile>) LoadPriFiles(IIterable<IStorageFile>)

Loads one or more resource index ("PRI") files and adds their contents to the default resource manager.

UnloadPriFiles(IIterable<IStorageFile>) UnloadPriFiles(IIterable<IStorageFile>) UnloadPriFiles(IIterable<IStorageFile>) UnloadPriFiles(IIterable<IStorageFile>) UnloadPriFiles(IIterable<IStorageFile>)

Unloads one or more resource index ("PRI") files.

See Also