GetDocumentInfo
Editor.GetDocumentInfo method
Devuelve metadatos sobre el documento, que se cargó en esta instancia de ‘Editor’
public IDocumentInfo GetDocumentInfo(string password)
Parámetro | Escribe | Descripción |
---|---|---|
password | String | El usuario puede especificar una contraseña para un documento, si este documento está encriptado con la contraseña. Puede ser NULL o una cadena vacía, que es equivalente a la contraseña ausente. Para aquellos formatos de documentos que no tienen una característica de protección con contraseña, este argumento será ignorado. Si el documento está encriptado y la contraseña no se especifica en este parámetro, pero se especificó antes en las opciones de carga al crear esteEditor ejemplo, se utilizará. |
Valor_devuelto
Heredero específico del formato deIDocumentInfo
interfaz, que indica el formato detectado con metadatos específicos del formato, o NULL, si el documento no se reconoció como compatible o está dañado.
Excepciones
excepción | condición |
---|---|
ObjectDisposedException | Se lanza cuando la instancia del Editor ya se eliminó cuando se invoca “GetDocumentInfo”. |
PasswordRequiredException | Se lanza cuando el documento cargado está protegido con contraseña, pero la contraseña no se especificó en el parámetro “password” |
IncorrectPasswordException | Se lanza cuando el documento cargado está protegido con contraseña, se especifica la contraseña, pero es incorrecta |
InvalidOperationException | Se lanza cuando se ha producido un error inesperado de naturaleza desconocida. |
Observaciones
El método GetDocumentInfo es útil cuando no está claro qué formato es el documento de entrada, si está protegido con contraseña y/o cuántas páginas/hojas de trabajo/diapositivas contiene. Según estos metadatos, devueltos por GetDocumentInfo, es posible ajustar correctamente las opciones de carga y edición para la canalización de procesamiento principal.
El método GetDocumentInfo siempre devuelve datos completos, no se ve afectado por el modo de prueba, su uso no cancela los bytes o créditos consumidos.
Aprende más
- Obtenga más información sobre cómo obtener propiedades específicas del documento en el código: Cómo obtener información de documentos usando GroupDocs.Editor
Ver también
- interface IDocumentInfo
- class Editor
- espacio de nombres GroupDocs.Editor
- asamblea GroupDocs.Editor