Share via

StorageItemContentProperties Class

  • Reference

Definition

Namespace:
Windows.Storage.FileProperties
Edit

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

public ref class StorageItemContentProperties sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class StorageItemContentProperties final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class StorageItemContentProperties
Public NotInheritable Class StorageItemContentProperties
Inheritance
Object Platform::Object IInspectable StorageItemContentProperties
Attributes
ContractVersionAttribute
Implements
IStorageItemExtraProperties

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

This example demonstrates how to retrieve content properties or specified properties from a file using StorageFile.Properties.

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

        // Specify more properties to retrieve
        readonly string dateAccessedProperty = "System.DateAccessed";
        readonly string fileOwnerProperty = "System.FileOwner";
        List<string> propertiesName = new List<string>();
        propertiesName.Add(dateAccessedProperty);
        propertiesName.Add(fileOwnerProperty);

        // Get the specified properties through StorageFile.Properties
        IDictionary<string, object> extraProperties = await file.Properties.RetrievePropertiesAsync(propertiesName);
        var propValue = extraProperties[dateAccessedProperty];
        if (propValue != null)
        {
            outputText.AppendLine("Date accessed: " + propValue);
        }
        propValue = extraProperties[fileOwnerProperty];
        if (propValue != null)
        {
            outputText.AppendLine("File owner: " + propValue);
        }
    }
}
// Handle errors with catch blocks
catch (FileNotFoundException)
{
 // For example, handle a file not found error
}

After GetImagePropertiesAsync completes, imageProperties gets a ImageProperties object. Additionally, after RetrievePropertiesAsync completes, extraProperties gets an object that contains the specified properties (the list of supported properties can be found on the Core properties page).

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

Remarks

You can get a StorageItemContentProperties object using the Properties property that is available on the following objects:

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.

Methods

GetDocumentPropertiesAsync()

Retrieves the document properties of the item (like a file of folder).
GetImagePropertiesAsync()

Retrieves the image properties of the item (like a file of folder).
GetMusicPropertiesAsync()

Retrieves the music properties of the item (like a file of folder).
GetVideoPropertiesAsync()

Retrieves the video properties of the item (like a file of folder).
RetrievePropertiesAsync(IIterable<String>)

Retrieves the specified properties associated with the item.
SavePropertiesAsync()

Saves all properties associated with the item.
SavePropertiesAsync(IIterable<KeyValuePair<String,Object>>)

Saves the specified properties and values associated with the item.

Applies to

See also