DocumentProperties class

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

Syntax

public ref class DocumentProperties sealed : Object,
    IStorageItemExtraProperties

Attributes

MarshalingBehaviorAttribute(Agile)

VersionAttribute(NTDDI_WIN8)

Members

The DocumentProperties class has these types of members:

• Methods
• Properties

Methods

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

Properties

The DocumentProperties class has these properties.

Remarks

You can access a DocumentProperties object asynchronously using the GetDocumentPropertiesAsync method from the Properties property of an item (like a file of folder), or synchronously using the DocumentProperties property if it is available.

You can get a DocumentProperties object using any of the following methods and properties:

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

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.

Windows Phone 8

This API is not implemented and will throw an exception if called.

Examples

This example demonstrates how to use a file query that is backed by the system index to retrieve document properties like Title.

While the example uses the DocumentsLibrary to create the query, you can create a query like this for any folder you have access to that you can get as a StorageFolder.

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

Requirements

See also

StorageItemContentProperties.getDocumentPropertiesAsync method

Windows.Storage.BulkAccess.FileInformation.documentProperties property

Windows.Storage.BulkAccess.FolderInformation.documentProperties property

Windows.Storage.BulkAccess.IStorageItemInformation.DocumentProperties property

Build date: 2/25/2013