NamedResource NamedResource NamedResource NamedResource NamedResource Class

Definition

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

public : sealed class NamedResource : INamedResource
struct winrt::Windows::ApplicationModel::Resources::Core::NamedResource : INamedResource
public sealed class NamedResource : INamedResource
Public NotInheritable Class NamedResource Implements INamedResource
// 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

Candidates Candidates Candidates Candidates Candidates

Gets all possible candidate values for this named resource.

Uri Uri Uri Uri Uri

Gets a URI that can be used to refer to this named resource.

Methods

Resolve() Resolve() Resolve() Resolve() Resolve()

Note

Resolve may be altered or unavailable for releases after Windows 8.1. Instead, use Resolve(ResourceContext).

Resolves this NamedResource object against the default context and returns the most appropriate candidate.

Resolve(ResourceContext) Resolve(ResourceContext) Resolve(ResourceContext) Resolve(ResourceContext) Resolve(ResourceContext)

Resolves this NamedResource object against a supplied context and returns the most appropriate candidate.

ResolveAll() ResolveAll() ResolveAll() ResolveAll() ResolveAll()

Note

ResolveAll may be altered or unavailable for releases after Windows 8.1. Instead, use ResolveAll(ResourceContext).

Resolves this NamedResource object against the default context and returns a list of all possible candidates in preference order.

ResolveAll(ResourceContext) ResolveAll(ResourceContext) ResolveAll(ResourceContext) ResolveAll(ResourceContext) ResolveAll(ResourceContext)

Resolves this NamedResource object against a supplied context and returns a list of all possible candidates in preference order.

See Also