GetDocumentInfo

Editor.GetDocumentInfo method

Retourneert metadata over het document dat in deze ‘Editor’-instantie is geladen

public IDocumentInfo GetDocumentInfo(string password)
Parameter Type Beschrijving
password String De gebruiker kan een wachtwoord voor een document specificeren, als dit document is versleuteld met het wachtwoord. Mag NULL zijn of een lege tekenreeks, dat is gelijk aan het ontbrekende wachtwoord. Voor die documentindelingen die geen functie voor wachtwoordbeveiliging hebben, wordt dit argument genegeerd. Als het document is gecodeerd en het wachtwoord niet is opgegeven in deze parameter, maar eerder is opgegeven in de laadopties tijdens het maken hiervanEditor het zal bijvoorbeeld worden gebruikt.

Winstwaarde

Formaatspecifieke erfgenaam vanIDocumentInfo interface, die het gedetecteerde formaat aangeeft met formaatspecifieke metadata, of NULL, als het document niet als ondersteund werd herkend of beschadigd is.

Uitzonderingen

uitzondering voorwaarde
ObjectDisposedException Wordt gegenereerd wanneer de Editor-instantie al is verwijderd wanneer “GetDocumentInfo” wordt aangeroepen
PasswordRequiredException Wordt gegenereerd wanneer het geladen document met een wachtwoord is beveiligd, maar het wachtwoord niet is opgegeven in de parameter “password”
IncorrectPasswordException Wordt gegenereerd wanneer het geladen document met een wachtwoord is beveiligd, het wachtwoord is opgegeven, maar onjuist is
InvalidOperationException Wordt gegenereerd wanneer er een onverwachte fout van onbekende aard is opgetreden

Opmerkingen

De methode GetDocumentInfo is handig wanneer het onduidelijk is in welk formaat het invoerdocument is, of het met een wachtwoord is beveiligd en/of hoeveel pagina’s/werkbladen/dia’s het bevat. Op basis van deze metadata, geretourneerd door GetDocumentInfo, is het mogelijk om de laad- en bewerkingsopties voor de hoofdverwerkingspijplijn correct aan te passen.

De GetDocumentInfo-methode retourneert altijd volledige gegevens, wordt niet beïnvloed door de proefmodus, het gebruik ervan schrijft de verbruikte bytes of credits niet af.

Kom meer te weten

Zie ook

Edit Save