导出 (0) 打印
全部展开
信息
您所需的主题如下所示。但此主题未包含在此库中。

DocumentProperties Class

提供对项的文档相关属性的访问(如文件或文件夹)。

语法


var documentProperties = fileInformation.documentProperties;

特性

[Version(0x06020000)]

成员

DocumentProperties类 具有这些类型的成员:

方法

The DocumentProperties 类 具有这些方法。 对于 C#、Visual Basic 和 C++,它还继承方法于Object 类.

方法说明
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.

 

属性

DocumentProperties类 具有这些属性。

属性访问类型说明

Author

只读Gets the name of the document author.

Comment

读/写Gets or sets the comments associated with the document.

Keywords

只读Gets the collection of keywords associated with the document.

Title

读/写Gets or sets the title of the document.

 

备注

如果可用,您可以使用项(如文件或文件夹)的 Properties 属性中的 GetDocumentPropertiesAsync 方法以异步的方式,或使用 DocumentProperties 属性以同步的方式访问 DocumentProperties 对象。

使用以下任意方法和属性,可以获取 DocumentProperties 对象:

注意  使用由另一个应用程序定义的属性处理程序(如 Microsoft Word)获取或设置属性可能不可访问。相反,您可以使用由系统索引返回的文件查询尝试获取这些属性。 有关更多信息,请参见 QueryOptions

有关访问属性的更多代码示例,请参见文件访问示例

Windows Phone 8

此 API 不实现,但是调用时会引发异常。请参见 Windows Phone 运行时 API

示例

此示例演示如何使用由系统索引支持的文件查询来检索如 Title 的文件属性。



// Create index backed file query and get results
var documentsLibrary = Windows.Storage.KnownFolders.documentsLibrary;
var fileTypeFilter = [".docx"];
var queryOptions = new Windows.Storage.Search.QueryOptions(Windows.Storage.Search.CommonFileQuery.orderByName, fileTypeFilter);
queryOptions.indexerOption = Windows.Storage.Search.IndexerOption.onlyUseIndexer;
var fileQuery = documentsLibrary.createFileQueryWithOptions(queryOptions);
fileQuery.getFilesAsync().then(function (files) {
    // Process resulting files
    if (files.size === 0) {
        // Perform tasks to handle no files found
    } else {
        // Access properties for each file
        files.forEach(function (file) {
            // Get document properties
            file.properties.getDocumentPropertiesAsync().done(function (documentProperties) {
                // Perform tasks with document properties
                var title = documentProperties.title;
            });
        });
    }
},
// Handle errors with an error function
function (error) {
    // Handle errors encountered while processing files
});

当该示例使用 DocumentsLibrary 创建查询时,可以为访问的任何文件夹创建这样的查询以便可以获取作为 StorageFolder

在示例中,file 包含在表示文件以检索属性的 StorageFile

要求

最低支持客户端

Windows 8 [仅 Windows 应用商店应用程序]

最低支持服务器

Windows Server 2012 [仅 Windows 应用商店应用程序]

最低支持电话

Windows Phone 8 [未实现,请参见备注]

命名空间

Windows.Storage.FileProperties
Windows::Storage::FileProperties [C++]

元数据

Windows.winmd

另请参见

StorageItemContentProperties.getDocumentPropertiesAsync method
Windows.Storage.BulkAccess.FileInformation.documentProperties property
Windows.Storage.BulkAccess.FolderInformation.documentProperties property
Windows.Storage.BulkAccess.IStorageItemInformation.DocumentProperties property

 

 

显示:
© 2014 Microsoft