DocumentProperties 类

定义

命名空间:

Windows.Storage.FileProperties

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

public ref class DocumentProperties sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class DocumentProperties final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class DocumentProperties

Public NotInheritable Class DocumentProperties

继承

Object Platform::Object IInspectable DocumentProperties

属性

ContractVersionAttribute

实现

IStorageItemExtraProperties

Windows 要求

设备系列	Windows 10 (在 10.0.10240.0 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

示例

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

try
{
    // Create index backed file query and get results
    List<string> fileTypeFilter = new List<string>();
    fileTypeFilter.Add(".docx");
    QueryOptions queryOptions = new QueryOptions(Windows.Storage.Search.CommonFileQuery.OrderByName, fileTypeFilter);
    queryOptions.IndexerOption = IndexerOption.OnlyUseIndexer;
    StorageFileQueryResult queryResult = Windows.Storage.KnownFolders.DocumentsLibrary.CreateFileQueryWithOptions(queryOptions);
    var files = await queryResult.GetFilesAsync();

    // Process resulting files
    if (files.Count == 0)
    {
        // Perform tasks to handle no files found
    }
    else
    {
        // Access properties for each file
        foreach (StorageFile file in files)
        {
            var documentProperties = await file.Properties.GetDocumentPropertiesAsync();
            // Perform tasks with document properties
            String title = documentProperties.Title;
        }
    }
}
// Handle errors with catch blocks
catch (FileNotFoundException)
{
 // For example, handle a file not found error
}

虽然该示例使用 DocumentsLibrary 创建查询，但你可以为作为 StorageFolder 获取的任何有权访问的文件夹创建这样的查询。

在示例中， file 包含一个 StorageFile ，表示要为其检索属性的文件。

注解

可以使用 GetDocumentPropertiesAsync 方法从项的 Properties 属性（如文件夹 () 文件）使用 GetDocumentPropertiesAsync 方法异步访问 DocumentProperties 对象，或者使用 DocumentProperties 属性（如果可用）进行同步访问。 可以使用以下任一方法和属性获取 DocumentProperties 对象：

• FileInformation.documentProperties 属性
• FolderInformation.documentProperties 属性
• StorageItemContentProperties.getDocumentPropertiesAsync 方法，可以使用 Properties 属性（如果可用）访问该方法。

注意

使用由其他应用（如 Microsoft Word) ）定义的属性处理程序获取或设置的属性 (可能无法访问。 相反，可以尝试使用由系统索引支持的文件查询来获取这些属性。 有关详细信息，请参阅 QueryOptions。

有关访问属性的更多代码示例，请参阅 文件访问示例。

属性

Author	获取文档作者的集合。
Comment	获取或设置与文档关联的注释。
Keywords	获取与文档关联的关键字的集合。
Title	获取或设置文档的标题。

方法

RetrievePropertiesAsync(IIterable<String>)	检索与项关联的指定属性。
SavePropertiesAsync()	保存与项关联的所有属性。
SavePropertiesAsync(IIterable<KeyValuePair<String,Object>>)	保存与项关联的指定属性和值。

另请参阅

• GetDocumentPropertiesAsync()
• DocumentProperties
• DocumentProperties
• DocumentProperties