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 引進)

範例

此範例示範如何使用系統索引所支援的檔案查詢來擷取 標題之類的檔案屬性。

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 屬性非同步存取 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