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.

В этом примере содержит файл StorageFile, представляющий файл, file для которого требуется извлечь свойства.

Комментарии

Доступ к объекту DocumentProperties можно получить асинхронно с помощью метода GetDocumentPropertiesAsync из свойства Properties элемента (например, файла папки) или синхронно с помощью свойства 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