ImageProperties class (Windows)

3 out of 5 rated this helpful - Rate this topic

Provides access to the image-related properties of an item (like a file or folder).

Syntax


var imageProperties = fileInformation.imageProperties;

Attributes

MarshalingBehaviorAttribute(Agile)
VersionAttribute(NTDDI_WIN8)

Members

The ImageProperties class has these types of members:

Methods
Properties

Methods

The ImageProperties class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

Method	Description
RetrievePropertiesAsync	Retrieves the specified properties associated with the item.
SavePropertiesAsync()	Saves all properties associated with the item.
SavePropertiesAsync(IIterable(IKeyValuePair))	Saves the specified properties and values associated with the item.

Properties

The ImageProperties class has these properties.

Property	Access type	Description
CameraManufacturer	Read/write	Gets or sets the manufacturer of the camera that took the photo.
CameraModel	Read/write	Gets or sets the model of the camera that took the photo.
DateTaken	Read/write	Gets or sets the date when the image was taken.
Height	Read-only	Gets the height of the image.
Keywords	Read-only	Gets the collection of keywords associated with the image.
Latitude	Read-only	Gets the latitude coordinate where the photo was taken.
Longitude	Read-only	Gets the longitude coordinate where the photo was taken.
Orientation	Read-only	Gets the Exchangeable Image File (EXIF) orientation flag of the photo.
PeopleNames	Read-only	Gets the names of people who are tagged in the photo.
Rating	Read/write	Gets the rating associated with the image.
Title	Read/write	Gets or sets the title of the image.
Width	Read-only	Gets the width of the image.

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

Note Properties that are get or set using a property handler that is defined by another app (like Microsoft Word) may not be accessible. Instead, you can try to get these properties using a file query that is backed by the system index. For more information, see QueryOptions.

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

Examples

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

JavaScript



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.

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Minimum supported phone	Windows Phone 8
Namespace	Windows.Storage.FileProperties Windows::Storage::FileProperties [C++]
Metadata	Windows.winmd

ImageProperties class