ResourceCandidate ResourceCandidate ResourceCandidate ResourceCandidate ResourceCandidate Class


Represents a single possible value for a given NamedResource, the qualifiers associated with that resource, and how well those qualifiers match the context against which it was resolved.

public : sealed class ResourceCandidate
struct winrt::Windows::ApplicationModel::Resources::Core::ResourceCandidate
public sealed class ResourceCandidate
Public NotInheritable Class ResourceCandidate
// This class does not provide a public constructor.

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)


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


Version history

Windows version SDK version Value added
1903 18362 Kind


IsDefault IsDefault IsDefault IsDefault IsDefault

Indicates whether this ResourceCandidate can be used as a default fallback value for any context.

IsMatch IsMatch IsMatch IsMatch IsMatch

Indicates whether this ResourceCandidate matched the ResourceContext against which it was evaluated.

IsMatchAsDefault IsMatchAsDefault IsMatchAsDefault IsMatchAsDefault IsMatchAsDefault

Indicates whether this ResourceCandidate matched the ResourceContext against which it was evaluated as a result of being a true match, a default fallback value, or a mixed match with default fallback (that is, a match in relation to some qualifiers but using default fallback values for other qualifiers).

Kind Kind Kind Kind Kind

Gets the type of resource that is encapsulated in this ResourceCandidate.

Qualifiers Qualifiers Qualifiers Qualifiers Qualifiers

Gets the qualifiers associated with this ResourceCandidate.

ValueAsString ValueAsString ValueAsString ValueAsString ValueAsString

Gets the value of this ResourceCandidate, expressed as a string.


GetQualifierValue(String) GetQualifierValue(String) GetQualifierValue(String) GetQualifierValue(String) GetQualifierValue(String)

Returns the value of a qualifier, given its name.

GetValueAsFileAsync() GetValueAsFileAsync() GetValueAsFileAsync() GetValueAsFileAsync() GetValueAsFileAsync()

Asynchronously returns a StorageFile that accesses the value of this ResourceCandidate. This only works on certain types of ResourceCandidate s that are files.

GetValueAsStreamAsync() GetValueAsStreamAsync() GetValueAsStreamAsync() GetValueAsStreamAsync() GetValueAsStreamAsync()

Asynchronously returns an IRandomAccessStream that accesses the value of this ResourceCandidate.

See also