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
var resourceCandidate = resourceMap.getValue(string); var resourceCandidate = resourceMap.getValue(string, resourceContext); var resourceCandidate = namedResource.resolve(); var resourceCandidate = namedResource.resolve(resourceContext); var resourceCandidate = resourceCandidateVectorView.getAt(uInt32);
Attributes
- MarshalingBehaviorAttribute(Agile)
- VersionAttribute(NTDDI_WIN8)
Members
The ResourceCandidate class has these types of members:
Methods
The ResourceCandidate class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.
| Method | Description |
|---|---|
| GetQualifierValue | Returns the value of a qualifier, given its name. |
| GetValueAsFileAsync | Asynchronously returns a StorageFile that accesses the value of this ResourceCandidate. This only works on certain types of ResourceCandidates that are files. |
Properties
The ResourceCandidate class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Indicates whether this ResourceCandidate can be used as a default fallback value for any context. | |
| Read-only | Indicates whether this ResourceCandidate matched the ResourceContext against which it was evaluated. | |
| Read-only | Indicates whether this ResourceCandidate matched the ResourceContext against which it was evaluated as a result of being a default fallback value or mixed match with default fallback, and not as a true match. | |
| Read-only | Gets the qualifiers associated with this ResourceCandidate. | |
| Read-only | Gets the value of this ResourceCandidate, expressed as a string. |
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] |
|
Namespace |
|
|
Metadata |
|
See also
Build date: 12/4/2012
