Image​Properties Image​Properties Image​Properties Class

Definition

Namespace:
Windows.Storage.FileProperties Windows.Storage.FileProperties Windows.Storage.FileProperties
Edit

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

public : sealed class ImageProperties : IImageProperties, IStorageItemExtraPropertiespublic sealed class ImageProperties : IImageProperties, IStorageItemExtraPropertiesPublic NotInheritable Class ImageProperties Implements IImageProperties, IStorageItemExtraProperties
Attributes
ContractVersionAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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:

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.

Properties

CameraManufacturer CameraManufacturer CameraManufacturer

Edit

Gets or sets the manufacturer of the camera that took the photo.

public : PlatForm::String CameraManufacturer { get; set; }public string CameraManufacturer { get; set; }Public ReadWrite Property CameraManufacturer As string
Value
PlatForm::String string string

The manufacturer of the camera that took the photo.

Attributes
ContractVersionAttribute

CameraModel CameraModel CameraModel

Edit

Gets or sets the model of the camera that took the photo.

public : PlatForm::String CameraModel { get; set; }public string CameraModel { get; set; }Public ReadWrite Property CameraModel As string
Value
PlatForm::String string string

The model of the camera that took the photo.

Attributes
ContractVersionAttribute

DateTaken DateTaken DateTaken

Edit

Gets or sets the date when the image was taken.

public : DateTime DateTaken { get; set; }public DateTimeOffset DateTaken { get; set; }Public ReadWrite Property DateTaken As DateTimeOffset
Value
DateTime DateTimeOffset DateTimeOffset

The date when the image was taken.

Attributes
ContractVersionAttribute

Remarks

If the date property isn't set, this value defaults to 0 which can be translated into misleading dates in different programming languages. In JavaScript, for example, 0 translates to December 16, 1600. You should always check that this property is a real value and not 0.

Height Height Height

Edit

Gets the height of the image.

public : unsigned short Height { get; }public uint Height { get; }Public ReadOnly Property Height As uint
Value
unsigned short uint uint

The height of the image

, in pixels.

Attributes
ContractVersionAttribute

Keywords Keywords Keywords

Edit

Gets the collection of keywords associated with the image.

public : IVector<string> Keywords { get; }public IList<string> Keywords { get; }Public ReadOnly Property Keywords As IList<string>
Value
IVector<PlatForm::String> IList<string> IList<string>

The collection of keywords.

Attributes
ContractVersionAttribute

Remarks

This property is read-only. It returns a collection, and you can't delete or replace the collection itself. The contents of the collection, however, are not read-only. You can add items to the collection, remove items from the collection, and change existing items in the collection. Call the SavePropertiesAsync method of the parent class to save the updated contents of the collection.

Latitude Latitude Latitude

Edit

Gets the latitude coordinate where the photo was taken.

public : IReference<double> Latitude { get; }public Nullable<double> Latitude { get; }Public ReadOnly Property Latitude As Nullable<double>
Value
IReference<double> Nullable<double> Nullable<double>

The latitude coordinate where the photo was taken.

The system computes this coordinate using the following file properties:

Attributes
ContractVersionAttribute

Remarks

To set the latitude or longitude of the photo, you must set all four of the file properties that are used to compute the latitude coordinate.

For code examples that demonstrate working with Latitude, Longitude and their underlying file properties, see the Simple imaging sample.

Longitude Longitude Longitude

Edit

Gets the longitude coordinate where the photo was taken.

public : IReference<double> Longitude { get; }public Nullable<double> Longitude { get; }Public ReadOnly Property Longitude As Nullable<double>
Value
IReference<double> Nullable<double> Nullable<double>

The longitude coordinate where the photo was taken.

The system computes this coordinate using the following file properties:

Attributes
ContractVersionAttribute

Orientation Orientation Orientation

Edit

Gets the Exchangeable Image File (EXIF) orientation flag of the photo.

public : PhotoOrientation Orientation { get; }public PhotoOrientation Orientation { get; }Public ReadOnly Property Orientation As PhotoOrientation
Value
PhotoOrientation PhotoOrientation PhotoOrientation

The photo's Exchangeable Image File (EXIF) orientation flag.

Attributes
ContractVersionAttribute

PeopleNames PeopleNames PeopleNames

Edit

Gets the names of people who are tagged in the photo.

public : IVectorView<string> PeopleNames { get; }public IReadOnlyList<string> PeopleNames { get; }Public ReadOnly Property PeopleNames As IReadOnlyList<string>
Value
IVectorView<PlatForm::String> IReadOnlyList<string> IReadOnlyList<string>

A list of the names of people who are tagged in the photo.

Attributes
ContractVersionAttribute

Remarks

This property is read-only, similar to the Keywords property.

Rating Rating Rating

Edit

Gets or sets the rating associated with an image file.

public : unsigned short Rating { get; set; }public uint Rating { get; set; }Public ReadWrite Property Rating As uint
Value
unsigned short uint uint

The media file rating, as a value between 0 and 99.

Attributes
ContractVersionAttribute

Remarks

The rating property for this media file type is obtained from the Windows file properties, specifically from System.Rating. System.Rating has a value from 0 to 99. A value of 0 indicates that the file has not been rated.

Rating info is often presented to the user as a “star” metaphor, where a star rating can be from 0 to 5 stars. This is shown as the outline of 5 star shapes, with the current rating indicated by a horizontal color bar within the 5 star shapes. For more info, see Guidelines for the Rating control.

For HTML UI, the Rating control implements a star-rating behavior, but you’ll have convert a Rating property value into the star-count values that the Rating control uses for its properties.

For XAML UI there is no default rating control in the Windows Runtime XAML vocabulary. However, several third-party control vendors have created a XAML rating control.

Here’s some suggested logic for converting the 0-99 possible value of a Rating property to an integer value between 0 and 5 that is suitable for a 5-star UI presentation metaphor, and for the Rating control: uint starRating = rating == 0 ? 0 : (uint)Math.Round((double)rating / 25.0) + 1;.

See Also
Guidelines for the Rating control

Title Title Title

Edit

Gets or sets the title of the image.

public : PlatForm::String Title { get; set; }public string Title { get; set; }Public ReadWrite Property Title As string
Value
PlatForm::String string string

The image title.

Attributes
ContractVersionAttribute

Width Width Width

Edit

Gets the width of the image.

public : unsigned short Width { get; }public uint Width { get; }Public ReadOnly Property Width As uint
Value
unsigned short uint uint

The width of the image

, in pixels.

Attributes
ContractVersionAttribute

Methods

RetrievePropertiesAsync(IIterable<String>) RetrievePropertiesAsync(IIterable<String>) RetrievePropertiesAsync(IIterable<String>)

Edit

Retrieves the specified properties associated with the item.

public : IAsyncOperation<IMap<PlatForm::String, PlatForm::Object>> RetrievePropertiesAsync(IIterable<PlatForm::String> propertiesToRetrieve)public IAsyncOperation<IDictionary<string, object>> RetrievePropertiesAsync(IEnumerable<String> propertiesToRetrieve)Public Function RetrievePropertiesAsync(propertiesToRetrieve As IEnumerable<String>) As IAsyncOperation( Of IDictionarystring, object )
Parameters
propertiesToRetrieve
IIterable<PlatForm::String> IEnumerable<String> IEnumerable<String>

A collection that contains the names of the properties to retrieve.

Returns
IAsyncOperation<IMap<PlatForm::String, PlatForm::Object>> IAsyncOperation<IDictionary<string, object>> IAsyncOperation<IDictionary<string, object>>

When this method completes successfully, it returns a collection (type IMap ) that contains the specified properties and values as key-value pairs.

Attributes
RemoteAsyncAttribute

Remarks

In JavaScript, use then or done to specify handler functions that will capture and process the collection when it is returned.

SavePropertiesAsync() SavePropertiesAsync() SavePropertiesAsync()

Edit

Saves all properties associated with the item.

public : IAsyncAction SavePropertiesAsync()public IAsyncAction SavePropertiesAsync()Public Function SavePropertiesAsync() As IAsyncAction
Returns
IAsyncAction IAsyncAction IAsyncAction

No object or value is returned when this method completes.

Attributes
OverloadAttribute RemoteAsyncAttribute

Remarks

If any one of the property values is invalid, none of the values will be saved.

See Also
SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)
SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)

SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>) SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>) SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)

Edit

Saves the specified properties and values associated with the item.

public : IAsyncAction SavePropertiesAsync(IIterable<IKeyValuePair<PlatForm::String, PlatForm::Object>> propertiesToSave)public IAsyncAction SavePropertiesAsync(IEnumerable<KeyValuePair<String, Object>> propertiesToSave)Public Function SavePropertiesAsync(propertiesToSave As IEnumerable<KeyValuePair<String, Object>>) As IAsyncAction
Parameters
propertiesToSave
IIterable<IKeyValuePair<PlatForm::String, PlatForm::Object>> IEnumerable<KeyValuePair<String, Object>> IEnumerable<KeyValuePair<String, Object>>

A collection that contains the names and values of the properties to save as key-value pairs (type IKeyValuePair ).

Returns
IAsyncAction IAsyncAction IAsyncAction

No object or value is returned when this method completes.

Attributes
OverloadAttribute
See Also
SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)SavePropertiesAsync(IIterable<IKeyValuePair<String, Object>>)
SavePropertiesAsync()SavePropertiesAsync()SavePropertiesAsync()