DocumentProperties Classe

Riferimento

Definizione

Spazio dei nomi:: Windows.Storage.FileProperties

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Modifica

Fornisce l'accesso alle proprietà correlate al documento di un elemento , ad esempio un file o una cartella.

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

Ereditarietà: Object Platform::Object IInspectable DocumentProperties

Attributi: ContractVersionAttribute

Implementazioni: IStorageItemExtraProperties

Requisiti Windows

Famiglia di dispositivi	Windows 10 (è stato introdotto in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (è stato introdotto in v1.0)

Esempio

In questo esempio viene illustrato come usare una query di file supportata dall'indice di sistema per recuperare le proprietà del documento, ad esempio 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
}

Mentre l'esempio usa DocumentsLibrary per creare la query, è possibile creare una query come questa per qualsiasi cartella a cui si ha accesso che è possibile ottenere come StorageFolder.

Nell'esempio contiene file un oggetto StorageFile che rappresenta il file per il quale recuperare le proprietà.

Commenti

È possibile accedere a un oggetto DocumentProperties in modo asincrono usando il metodo GetDocumentPropertiesAsync dalla proprietà Properties di un elemento (ad esempio un file di cartella) o in modo sincrono utilizzando la proprietà DocumentProperties , se disponibile. È possibile ottenere un oggetto DocumentProperties utilizzando uno dei metodi e delle proprietà seguenti:

Proprietà FileInformation.documentProperties
Proprietà FolderInformation.documentProperties
Metodo StorageItemContentProperties.getDocumentPropertiesAsync a cui è possibile accedere usando la proprietà Properties , se disponibile.

Nota

Le proprietà che vengono recuperate o impostate usando un gestore di proprietà definito da un'altra app (ad esempio Microsoft Word) potrebbero non essere accessibili. È invece possibile provare a ottenere queste proprietà usando una query di file supportata dall'indice di sistema. Per altre informazioni, vedere QueryOptions.

Per altri esempi di codice sull'accesso alle proprietà, vedere l'esempio di accesso ai file.

Proprietà

Author	Ottiene l'insieme degli autori del documento.
Comment	Ottiene o imposta i commenti associati al documento.
Keywords	Ottiene la raccolta di parole chiave associate al documento.
Title	Ottiene o imposta il titolo del documento.

Metodi

RetrievePropertiesAsync(IIterable<String>)	Recupera le proprietà specificate associate all'elemento.
SavePropertiesAsync()	Salva tutte le proprietà associate all'elemento.
SavePropertiesAsync(IIterable<KeyValuePair<String,Object>>)	Salva le proprietà e i valori specificati associati all'elemento.

Si applica a

Condividi tramite