Skip to main content
ResourceMap class

A collection of related resources, typically either for a particular app package, or a resource file for a particular package.


var resourceMap = resourceMap.getSubtree();
var resourceMap = resourceManager.mainResourceMap;
var resourceMap = resourceMapMapView.lookup();

public sealed class ResourceMap : IReadOnlyDictionary<String, NamedResource>,

Public NotInheritable Class ResourceMap
    Implements IReadOnlyDictionary(Of String, NamedResource), _
    IEnumerable(Of KeyValuePair)

public ref class ResourceMap sealed : IMapView<String, NamedResource>,


The ResourceMap class has these types of members:


The ResourceMap class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

ContainsKey [C#, VB]Returns a value that indicates whether a specified key exists in the ResourceMap.
First [C++, JavaScript]Returns an iterator to enumerate the items in the map.
GetSubtree [C++, JavaScript]Returns a ResourceMap that represents a subtree of another ResourceMap, typically used to access a particular resource file within an app package.
GetValue(String) [C++, JavaScript]Returns the most appropriate candidate for a resource that is specified by a resource identifier within the default context.
GetValue(String, ResourceContext) [C++, JavaScript]Returns the most appropriate candidate for a resource that is specified by a resource identifier for the supplied context.
HasKey [C++, JavaScript]Determines whether the map can retrieve a resource with the specified resource identifier.
Lookup [C++, JavaScript]Returns the NamedResource at the specified resource identifier in the map.
Split [C++, JavaScript]Splits the map view into two views.
TryGetValue [C#, VB]Returns a value that indicates whether a specified key exists in the ResourceMap. If an item with that key exists, the item is retrieved as an out parameter.



The ResourceMap class has these properties.

PropertyAccess typeDescription

Count [C#, VB]


Gets the number of elements contained in the collection.

Item [C#, VB]


Gets or sets the element value at the specified key index.

Keys [C#, VB]


Gets an enumerable set containing the keys of the ResourceMap.

Size [C++, JavaScript]


Gets the number of resources in the map.



Gets a URI that can be used to refer to this ResourceMap.

Values [C#, VB]


Gets an enumerable set containing the values of the ResourceMap.



Collection member lists

For JavaScript, ResourceMap supports using an index to access items.


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 = [

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";

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0


Windows::ApplicationModel::Resources::Core [C++]



Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]


Windows::ApplicationModel::Resources::Core [C++]




[ MarshalingBehavior(Agile)]
[ Version(0x06020000)]

See also

IMapView(String, NamedResource)
Application resources and localization sample