NamedResource class

Applies to Windows and Windows Phone

Represents a single logical, named resource, such as a string resource named 'Header1'.

Syntax


var namedResource = resourceMap.lookup(key);

Attributes

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

Members

The NamedResource class has these types of members:

Methods

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

MethodDescription
Resolve Resolves this NamedResource object against the default context and returns the most appropriate candidate.
Resolve(ResourceContext) Resolves this NamedResource object against a supplied context and returns the most appropriate candidate.
ResolveAll Resolves this NamedResource object against the default context and returns a list of all possible candidates in preference order.
ResolveAll(ResourceContext) Resolves this NamedResource object against a supplied context and returns a list of all possible candidates in preference order.

 

Properties

The NamedResource class has these properties.

PropertyAccess typeDescription

Candidates

Read-onlyGets all possible candidate values for this named resource.

Uri

Read-onlyGets a URI that can be used to refer to this named resource.

 

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

Requirements

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]

Namespace

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

Metadata

Windows.winmd

See also

Application resources and localization sample

 

 

Show:
© 2014 Microsoft