GetDocumentInfo

Editor.GetDocumentInfo method

Gibt Metadaten über das Dokument zurück, das in diese ‘Editor’-Instanz geladen wurde

public IDocumentInfo GetDocumentInfo(string password)
Parameter Typ Beschreibung
password String Der Benutzer kann ein Passwort für ein Dokument angeben, wenn dieses Dokument mit dem Passwort verschlüsselt ist. Kann NULL oder eine leere Zeichenfolge sein, die dem fehlenden Passwort entspricht. Bei Dokumentformaten ohne Passwortschutz wird dieses Argument ignoriert. Wenn das Dokument verschlüsselt ist und das Passwort in diesem Parameter nicht angegeben ist, aber es zuvor in den Ladeoptionen beim Erstellen angegeben wurdeEditor Beispiel, es wird verwendet.

Rückgabewert

Formatspezifischer Erbe vonIDocumentInfo Schnittstelle, die das erkannte Format mit formatspezifischen Metadaten angibt, oder NULL, , wenn das Dokument nicht als unterstützbar erkannt wurde oder beschädigt ist.

Ausnahmen

Ausnahme Bedingung
ObjectDisposedException Wird ausgelöst, wenn die Editor-Instanz bereits verworfen wurde, wenn „GetDocumentInfo“ aufgerufen wird
PasswordRequiredException Wird ausgelöst, wenn das geladene Dokument passwortgeschützt ist, aber das Passwort nicht im Parameter “password
IncorrectPasswordException Wird ausgelöst, wenn das geladene Dokument passwortgeschützt ist, das Passwort angegeben ist, aber falsch ist
InvalidOperationException Wird ausgelöst, wenn ein unerwarteter Fehler unbekannter Art aufgetreten ist

Bemerkungen

Die GetDocumentInfo-Methode ist nützlich, wenn unklar ist, welches Format das Eingabedokument hat, ob es passwortgeschützt ist und/oder wie viele Seiten/Arbeitsblätter/Folien es enthält. Basierend auf diesen von GetDocumentInfo zurückgegebenen Metadaten ist es möglich, die Lade- und Bearbeitungsoptionen für die Hauptverarbeitungspipeline korrekt anzupassen.

Die GetDocumentInfo-Methode gibt immer vollständige Daten zurück, sie ist vom Testmodus nicht betroffen, ihre Verwendung schreibt die verbrauchten Bytes oder Credits nicht ab.

Erfahren Sie mehr

Siehe auch