DocumentProperties Klasse

  • Referenz

Definition

Namespace:
Windows.Storage.FileProperties
Bearbeiten

Ermöglicht den Zugriff auf die dokumentbezogenen Eigenschaften eines Elements (z. B. eine Datei oder einen Ordner).

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
Vererbung
Object Platform::Object IInspectable DocumentProperties
Attribute
ContractVersionAttribute
Implementiert
IStorageItemExtraProperties

Windows-Anforderungen

Gerätefamilie
Windows 10 (eingeführt in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (eingeführt in v1.0)

Beispiele

In diesem Beispiel wird veranschaulicht, wie Sie eine Dateiabfrage verwenden, die vom Systemindex unterstützt wird, um Dokumenteigenschaften wie Title abzurufen.

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
}

Während im Beispiel die DocumentsLibrary zum Erstellen der Abfrage verwendet wird, können Sie eine Abfrage wie diese für jeden Ordner erstellen, auf den Sie Zugriff haben, den Sie als StorageFolder abrufen können.

Enthält im Beispiel eine StorageFile-Datei, die die Datei darstellt, file für die Eigenschaften abgerufen werden sollen.

Hinweise

Sie können auf ein DocumentProperties-Objekt asynchron zugreifen, indem Sie die GetDocumentPropertiesAsync-Methode über die Properties-Eigenschaft eines Elements (z. B. eine Ordnerdatei) oder synchron die DocumentProperties-Eigenschaft verwenden, wenn sie verfügbar ist. Sie können ein DocumentProperties-Objekt mit einer der folgenden Methoden und Eigenschaften abrufen:

Hinweis

Auf Eigenschaften, die mithilfe eines Eigenschaftenhandlers abgerufen oder festgelegt werden, der von einer anderen App (z. B. Microsoft Word) definiert wird, kann möglicherweise nicht zugegriffen werden. Stattdessen können Sie versuchen, diese Eigenschaften mithilfe einer Dateiabfrage abzurufen, die vom Systemindex unterstützt wird. Weitere Informationen finden Sie unter QueryOptions.

Weitere Codebeispiele zum Zugriff auf Eigenschaften finden Sie im Dateizugriffsbeispiel.

Eigenschaften

Author

Ruft die Auflistung der Autoren des Dokuments ab.
Comment

Ruft die dem Dokument zugeordneten Kommentare ab oder legt diese fest.
Keywords

Ruft die Auflistung von Schlüsselwörtern ab, die dem Dokument zugeordnet sind.
Title

Ruft den Titel des Dokuments ab oder legt den Titel fest.

Methoden

RetrievePropertiesAsync(IIterable<String>)

Ruft die angegebenen Eigenschaften ab, die dem Element zugeordnet sind.
SavePropertiesAsync()

Speichert alle Eigenschaften, die dem Element zugeordnet sind.
SavePropertiesAsync(IIterable<KeyValuePair<String,Object>>)

Speichert die angegebenen Eigenschaften und Werte, die dem Element zugeordnet sind.

Gilt für:

Weitere Informationen