GetDocumentInfo
Editor.GetDocumentInfo method
Renvoie les métadonnées sur le document, qui a été chargée dans cette instance ‘Editor’
public IDocumentInfo GetDocumentInfo(string password)
Paramètre | Taper | La description |
---|---|---|
password | String | L’utilisateur peut spécifier un mot de passe pour un document, si ce document est crypté avec le mot de passe. Peut être NULL ou une chaîne vide, qui équivaut au mot de passe absent. Pour les formats de document qui n’ont pas de fonction de protection par mot de passe, cet argument sera ignoré. Si le document est crypté et que le mot de passe n’est pas spécifié dans ce paramètre, mais qu’il a été spécifié auparavant dans les options de chargement lors de la création de ceEditor exemple, il sera utilisé. |
Return_Value
Héritier spécifique au format deIDocumentInfo
interface, qui indique le format détecté avec des métadonnées spécifiques au format, ou NULL, si le document n’a pas été reconnu comme supportable ou est corrompu.
Exceptions
exception | condition |
---|---|
ObjectDisposedException | Est levé lorsque l’instance de l’éditeur a déjà été supprimée lorsque “GetDocumentInfo” est appelé |
PasswordRequiredException | Est émis lorsque le document chargé est protégé par un mot de passe, mais que le mot de passe n’a pas été spécifié dans le paramètre “password” |
IncorrectPasswordException | Est émis lorsque le document chargé est protégé par un mot de passe, le mot de passe est spécifié, mais est incorrect |
InvalidOperationException | Est émis lorsqu’une erreur inattendue de nature inconnue s’est produite |
Remarques
La méthode GetDocumentInfo est utile lorsqu’il n’est pas clair quel format est le document d’entrée, est-il protégé par un mot de passe et/ou combien de pages/feuilles de calcul/diapositives il contient. Sur la base de ces métadonnées, renvoyées par GetDocumentInfo, il est possible d’ajuster correctement les options de chargement et d’édition du pipeline de traitement principal.
La méthode GetDocumentInfo renvoie toujours des données complètes, elle n’est pas affectée par le mode d’essai, son utilisation n’annule pas les octets ou les crédits consommés.
Apprendre encore plus
- En savoir plus sur l’obtention de propriétés spécifiques au document dans le code : Comment obtenir des informations sur un document à l’aide de GroupDocs.Editor
Voir également
- interface IDocumentInfo
- class Editor
- espace de noms GroupDocs.Editor
- Assemblée GroupDocs.Editor