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 が含まれています。

注釈

DocumentProperties オブジェクトには、アイテムの Properties プロパティ (フォルダーのファイルなど) から GetDocumentPropertiesAsync メソッドを使用して非同期的にアクセスするか、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