DocumentProperties Classe

Définition

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

Héritage

Object Platform::Object IInspectable DocumentProperties

Attributs

ContractVersionAttribute

Implémente

IStorageItemExtraProperties

Configuration requise pour Windows

Exemples

Cet exemple montre comment utiliser une requête de fichier adossée à l’index système pour récupérer des propriétés de document telles que Titre.

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
}

Bien que l’exemple utilise DocumentsLibrary pour créer la requête, vous pouvez créer une requête comme celle-ci pour n’importe quel dossier auquel vous avez accès que vous pouvez obtenir en tant que StorageFolder.

Dans l’exemple, file contient un StorageFile qui représente le fichier pour lequel récupérer les propriétés.

Remarques

Vous pouvez accéder à un objet DocumentProperties de manière asynchrone à l’aide de la méthode GetDocumentPropertiesAsync à partir de la propriété Properties d’un élément (comme un fichier de dossier) ou de façon synchrone à l’aide de la propriété DocumentProperties si elle est disponible. Vous pouvez obtenir un objet DocumentProperties à l’aide de l’une des méthodes et propriétés suivantes :

• Propriété FileInformation.documentProperties
• Propriété FolderInformation.documentProperties
• Méthode StorageItemContentProperties.getDocumentPropertiesAsync , accessible à l’aide de la propriété Properties , si elle est disponible.

Pour obtenir d’autres exemples de code sur l’accès aux propriétés, consultez l’exemple Accès aux fichiers.

Propriétés

Méthodes

S’applique à

Voir aussi

• GetDocumentPropertiesAsync()
• DocumentProperties
• DocumentProperties
• DocumentProperties