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.

Syntax

Declaration

public sealed class ResourceCandidatepublic sealed class ResourceCandidatePublic NotInheritable Class ResourceCandidate

Remarks

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 summary

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

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

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).

Gets the qualifiers associated with this ResourceCandidate.

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

Methods summary

Returns the value of a qualifier, given its name.

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

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

Properties

  • IsDefault
    IsDefault
    IsDefault
    IsDefault

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

    public bool IsDefault { get; }public bool IsDefault { get; }Public ReadOnly Property IsDefault As bool

    Property Value

    • bool
      bool
      bool
      bool

      TRUE if this candidate can be used as a default fallback value for any context, FALSE otherwise.

  • IsMatch
    IsMatch
    IsMatch
    IsMatch

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

    public bool IsMatch { get; }public bool IsMatch { get; }Public ReadOnly Property IsMatch As bool

    Property Value

    • bool
      bool
      bool
      bool

      TRUE if the ResourceCandidate matched the context, FALSE otherwise.

  • 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).

    public bool IsMatchAsDefault { get; }public bool IsMatchAsDefault { get; }Public ReadOnly Property IsMatchAsDefault As bool

    Property Value

    • bool
      bool
      bool
      bool

      TRUE if this candidate is an acceptable default fallback value, FALSE otherwise.

  • Qualifiers
    Qualifiers
    Qualifiers
    Qualifiers

    Gets the qualifiers associated with this ResourceCandidate.

    public IVectorView<ResourceQualifier> Qualifiers { get; }public IVectorView<ResourceQualifier> Qualifiers { get; }Public ReadOnly Property Qualifiers As IVectorView<ResourceQualifier>

    Property Value

  • ValueAsString
    ValueAsString
    ValueAsString
    ValueAsString

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

    public string ValueAsString { get; }public string ValueAsString { get; }Public ReadOnly Property ValueAsString As string

    Property Value

    • string
      string
      string
      string

      The string value.

Methods

  • GetQualifierValue(System.String)
    GetQualifierValue(System.String)
    GetQualifierValue(System.String)
    GetQualifierValue(System.String)

    Returns the value of a qualifier, given its name.

    public string GetQualifierValue(System.String)public string GetQualifierValue(System.String)Public Function GetQualifierValue(System.String) As string

    Parameters

    • qualifierName
      System.String
      System.String
      System.String
      System.String

      The name of the qualifier.

    Returns

    • string
      string
      string
      string

      The value of the qualifier.

  • 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.

    public IAsyncOperation<StorageFile> GetValueAsFileAsync()public IAsyncOperation<StorageFile> GetValueAsFileAsync()Public Function GetValueAsFileAsync() As IAsyncOperation( Of StorageFile )

    Returns

    • An asynchronous operation to return the requested StorageFile.

  • GetValueAsStreamAsync()
    GetValueAsStreamAsync()
    GetValueAsStreamAsync()
    GetValueAsStreamAsync()

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

    public IAsyncOperation<IRandomAccessStream> GetValueAsStreamAsync()public IAsyncOperation<IRandomAccessStream> GetValueAsStreamAsync()Public Function GetValueAsStreamAsync() As IAsyncOperation( Of IRandomAccessStream )

    Returns

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ContractVersionAttribute

Details

Assembly

Windows.ApplicationModel.Resources.Core.dll