ImageProperties ImageProperties ImageProperties ImageProperties ImageProperties Class

Definition

public : sealed class ImageProperties : IImageProperties, IStorageItemExtraProperties

struct winrt::Windows::Storage::FileProperties::ImageProperties : IImageProperties, IStorageItemExtraProperties

public sealed class ImageProperties : IImageProperties, IStorageItemExtraProperties

Public NotInheritable Class ImageProperties Implements IImageProperties, IStorageItemExtraProperties

// This class does not provide a public constructor.

Attributes

ContractVersionAttribute

Examples

This example demonstrates how to retrieve properties of a file, including image properties like DateTaken and Rating.

try
{
    StorageFile file = rootPage.sampleFile;
    if (file != null)
    {
        StringBuilder outputText = new StringBuilder();

        // Get image properties
        ImageProperties imageProperties = await file.Properties.GetImagePropertiesAsync();
        outputText.AppendLine("Date taken: " + imageProperties.DateTaken);
        outputText.AppendLine("Rating: " + imageProperties.Rating);
    }
}
// Handle errors with catch blocks
catch (FileNotFoundException)
{
 // For example, handle a file not found error
}

var file = SdkSample.sampleFile;
if (file !== null) {
    var outputDiv = document.getElementById("output");

    // Get image properties
    file.properties.getImagePropertiesAsync().done(function (imageProperties) {
        outputDiv.innerHTML += "Date taken: " + imageProperties.dateTaken + "<br/>";
        outputDiv.innerHTML += "Rating: " + imageProperties.rating + "<br/>";
    },
    // Handle errors with an error function
    function (error) {
       // Handle errors encountered while retrieving properties
    });
}

After GetImagePropertiesAsync completes, imageProperties gets a ImageProperties object.

In the example, file contains a StorageFile that represents the file to retrieve properties for.

Remarks

You can access a ImageProperties object asynchronously using the getImagePropertiesAsync method from the Properties property of an item (like a file of folder), or synchronously using the ImageProperties property if it is available. You can get a ImageProperties object using any of the following methods and properties:

• StorageItemContentProperties.getImagePropertiesAsync method, which can be accessed using the Properties property, if it is available.
• FileInformation.imageProperties property
• FolderInformation.imageProperties property

For more code samples about accessing properties, see the File access sample.

Properties

Methods

See Also

• GetImagePropertiesAsync()
• ImageProperties
• ImageProperties
• ImageProperties