Class Document
Contenido
[
Ocultar
]Clase Document
Clase que representa un documento PDF.
public sealed class Document : IDisposable
Constructores
| Nombre | Descripción |
|---|---|
| Document() | Inicializa un documento vacío. |
| Document(PdfVersion) | Inicializa un documento vacío por versión. |
| Document(Stream) | Inicializa una nueva instancia de Document desde el stream de entrada. |
| Document(string) | Solo inicializa Document usando filename. Lo mismo que Document. |
| Document(Stream, bool) | Inicializa una nueva instancia de Document desde el stream de entrada. |
| Document(Stream, LoadOptions) | Abre un documento existente desde un stream proporcionando la conversión necesaria para obtener el documento PDF. |
| Document(Stream, string) | Inicializa una nueva instancia de Document desde el stream de entrada. |
| Document(string, bool) | Solo inicializa Document usando filename. Lo mismo que Document. |
| Document(string, LoadOptions) | Abre un documento existente desde un archivo proporcionando las opciones de conversión necesarias para obtener el documento PDF. |
| Document(string, string) | Inicializa una nueva instancia de la clase Document para trabajar con documentos encriptados. |
| Document(Stream, string, bool) | Inicializa una nueva instancia de Document desde el stream de entrada. |
| Document(string, string, bool) | Inicializa una nueva instancia de la clase Document para trabajar con documentos encriptados. |
Propiedades
| Nombre | Descripción |
|---|---|
| Actions { get; } | Obtiene las acciones del documento. Esta propiedad es una instancia de la clase DocumentActions que permite obtener/establecer acciones como BeforClosing, BeforSaving, etc. |
| AllowReusePageContent { get; set; } | Permite fusionar contenidos de página para optimizar el tamaño del documento. Si se usa, entonces páginas diferentes pero duplicadas pueden hacer referencia al mismo objeto de contenido. Tenga en cuenta que este modo puede causar efectos secundarios como cambiar el contenido de la página cuando se cambia otra página. |
| Background { get; set; } | Obtiene o establece el color de fondo del documento. |
| CenterWindow { get; set; } | Obtiene o establece un indicador que especifica si la posición de la ventana del documento estará centrada en la pantalla. |
| Collection { get; set; } | Obtiene la colección del documento. |
| CryptoAlgorithm { get; } | Obtiene la configuración de seguridad si el documento está encriptado. Si el documento no está encriptado, se generará la excepción correspondiente en .net 1.1 o CryptoAlgorithm será nulo para otras versiones de .net. |
| Destinations { get; } | Obtiene la colección de destinos. Obsoleto. Por favor, use NamedDestinations. |
| Direction { get; set; } | Obtiene o establece el orden de lectura del texto: L2R (de izquierda a derecha) o R2L (de derecha a izquierda). |
| DisableFontLicenseVerifications { get; set; } | Muchas operaciones con fuentes no pueden ejecutarse si estas operaciones están prohibidas por la licencia de esta fuente. Por ejemplo, algunas fuentes no pueden ser incrustadas en un documento PDF si las reglas de licencia deshabilitan la incrustación para esta fuente. Este indicador se utiliza para deshabilitar cualquier restricción de licencia para todas las fuentes en el documento PDF actual. Tenga cuidado al usar este indicador. Cuando se establece, significa que la persona que establece este indicador asume toda la responsabilidad de posibles violaciones de licencia/ley. Por lo tanto, lo asume bajo su propio riesgo. Se recomienda encarecidamente usar este indicador solo cuando esté completamente seguro de que no está infringiendo la ley de derechos de autor. Por defecto, falso. |
| DisplayDocTitle { get; set; } | Obtiene o establece un indicador que especifica si la barra de título de la ventana del documento debe mostrar el título del documento. |
| Duplex { get; set; } | Obtiene o establece la opción de manejo del modo de impresión dúplex a utilizar al imprimir el archivo desde el cuadro de diálogo de impresión. |
| EmbeddedFiles { get; } | Obtiene la colección de archivos incrustados en el documento. |
| EmbedStandardFonts { get; set; } | Propiedad que declara que el documento debe incrustar todas las fuentes estándar Type1 que tienen el indicador IsEmbedded establecido en verdadero. Todas las fuentes PDF pueden ser incrustadas en el documento simplemente configurando el indicador IsEmbedded en verdadero, pero las fuentes estándar Type1 de PDF son una excepción a esta regla. La incrustación de fuentes estándar Type1 requiere mucho tiempo, por lo que para incrustar estas fuentes es necesario no solo establecer el indicador IsEmbedded en verdadero para la fuente especificada, sino también establecer un indicador adicional a nivel de documento: EmbedStandardFonts = true; Esta propiedad solo se puede establecer una vez para todas las fuentes. Por defecto, falso. |
| EnableObjectUnload { get; set; } | Obtiene o establece un indicador que permite que el documento se descargue parcialmente de la memoria. Esto permite disminuir el uso de memoria, pero puede tener un efecto negativo en el rendimiento. |
| EnableSignatureSanitization { get; set; } | Obtiene o establece un indicador para gestionar la sanitización de campos de firma. Habilitado por defecto. |
| FileName { get; } | Nombre del archivo PDF que causó este documento |
| FitWindow { get; set; } | Obtiene o establece un indicador que especifica si la ventana del documento debe ser redimensionada para ajustarse a la primera página mostrada. |
| FontUtilities { get; } | Instancia de IDocumentFontUtilities |
| Form { get; } | Obtiene el Acro Form del documento. |
| HandleSignatureChange { get; set; } | Lanza una excepción si el documento se guarda con cambios y tiene firma |
| HideMenubar { get; set; } | Obtiene o establece un indicador que especifica si la barra de menú debe estar oculta cuando el documento está activo. |
| HideToolBar { get; set; } | Obtiene o establece un indicador que especifica si la barra de herramientas debe estar oculta cuando el documento está activo. |
| HideWindowUI { get; set; } | Obtiene o establece un indicador que especifica si los elementos de la interfaz de usuario deben estar ocultos cuando el documento está activo. |
| Id { get; } | Obtiene el ID. |
| IgnoreCorruptedObjects { get; set; } | Obtiene o establece un indicador para ignorar errores en archivos fuente. Cuando las páginas del documento fuente se copian en el documento de destino, el proceso de copia se detiene con una excepción si algunos objetos en los archivos fuente están corruptos cuando este indicador es falso. ejemplo: dest.Pages.Add(src.Pages); Si este indicador se establece en verdadero, entonces los objetos corruptos serán reemplazados por valores vacíos. Por defecto: verdadero. |
| Info { get; } | Obtiene la información del documento. |
| IsEncrypted { get; } | Obtiene el estado de encriptación del documento. Verdadero si el documento está encriptado. |
| IsLinearized { get; set; } | Obtiene o establece un valor que indica si el documento está linealizado. |
| IsPdfaCompliant { get; } | Obtiene si el documento es compatible con pdfa. |
| IsPdfUaCompliant { get; } | Obtiene si el documento es compatible con pdfua. |
| IsXrefGapsAllowed { get; set; } | Obtiene o establece si el documento es compatible con pdfa. |
| JavaScript { get; } | Colección de JavaScript a nivel de documento. |
| LogicalStructure { get; } | Obtiene la estructura lógica del documento. |
| Metadata { get; } | Metadatos del documento. (Un documento PDF puede incluir información general, como el título del documento, autor y fechas de creación y modificación. Tal información global sobre el documento (en oposición a su contenido o estructura) se llama metadatos y está destinada a ayudar en la catalogación y búsqueda de documentos en bases de datos externas.) |
| NamedDestinations { get; } | Colección de Destinos Nombrados en el documento. |
| NonFullScreenPageMode { get; set; } | Obtiene o establece el modo de página, especificando cómo se debe mostrar el documento al salir del modo de pantalla completa. |
| OpenAction { get; set; } | Obtiene o establece la acción realizada al abrir el documento. |
| OptimizeSize { get; set; } | Obtiene o establece el indicador de optimización. Cuando se agregan páginas al documento, los flujos de recursos iguales en el archivo resultante se fusionan en un objeto PDF si este indicador está establecido. Esto permite disminuir el tamaño del archivo resultante, pero puede causar una ejecución más lenta y mayores requisitos de memoria. Valor predeterminado: falso. |
| Outlines { get; } | Obtiene los contornos del documento. |
| OutputIntents { get; } | Obtiene la colección de Intenciones de Salida en el documento. |
| PageInfo { get; set; } | Obtiene o establece la información de la página. (solo para generador, no se llena al leer el documento) |
| PageLabels { get; } | Obtiene las etiquetas de página en el documento. |
| PageLayout { get; set; } | Obtiene o establece el diseño de página que se utilizará al abrir el documento. |
| PageMode { get; set; } | Obtiene o establece el modo de página, especificando cómo se debe mostrar el documento al abrirse. |
| Pages { get; } | Obtiene o establece la colección de páginas del documento. Tenga en cuenta que las páginas están numeradas desde 1 en la colección. |
| PdfFormat { get; } | Obtiene el formato PDF |
| Permissions { get; } | Obtiene los permisos del documento. |
| PickTrayByPdfSize { get; set; } | Obtiene o establece un indicador que especifica si el tamaño de página PDF debe utilizarse para seleccionar la bandeja de papel de entrada. |
| PrintScaling { get; set; } | Obtiene o establece la opción de escalado de página que se seleccionará cuando se muestre un cuadro de diálogo de impresión para este documento. |
| TaggedContent { get; } | Obtiene acceso al contenido TaggedPdf. |
| Version { get; } | Obtiene una versión de Pdf del encabezado del archivo Pdf. |
| static FileSizeLimitToMemoryLoading { get; set; } | Obtiene y establece el límite de tamaño de archivo para cargar un archivo completo en memoria. El valor se establece en megabytes. El valor predeterminado es 210 Mb. |
| static IsLicensed { get; } | Obtiene el estado de licencia del sistema. Devuelve verdadero si el sistema funciona en modo licenciado y falso en caso contrario. |
Métodos
| Nombre | Descripción |
|---|---|
| static MergeDocuments(params Document[]) | Fusiona documentos. |
| static MergeDocuments(params string[]) | Fusiona archivos pdf. |
| static MergeDocuments(MergeOptions, params Document[]) | Fusiona documentos. |
| static MergeDocuments(MergeOptions, params string[]) | Fusiona documentos. |
| BindXml(Stream) | Vincula xml al documento |
| BindXml(string) | Vincula xml al documento |
| BindXml(Stream, Stream) | Vincula xml/xsl al documento |
| BindXml(string, string) | Vincula xml/xsl al documento |
| BindXml(Stream, Stream, XmlReaderSettings) | Vincula xml/xsl al documento |
| ChangePasswords(string, string, string) | Cambia las contraseñas del documento. Esta acción solo se puede realizar utilizando la contraseña del propietario. |
| Check(bool) | Valida el documento. |
| Convert(PdfFormatConversionOptions) | Convierte el documento utilizando las opciones de conversión especificadas |
| Convert(CallBackGetHocr, bool) | Reconoce imágenes dentro del documento y agrega cadenas hocr sobre ellas. |
| Convert(CallBackGetHocrWithPage, bool) | Reconoce imágenes dentro del documento y agrega cadenas hocr sobre ellas. |
| Convert(Stream, PdfFormat, ConvertErrorAction) | Convierte el documento y guarda errores en el stream especificado. |
| Convert(string, PdfFormat, ConvertErrorAction) | Convierte el documento y guarda errores en el archivo especificado. |
| Convert(Fixup, Stream, bool, object[]) | Convierte el documento aplicando el Fixup. |
| Convert(Fixup, string, bool, object[]) | Convierte el documento aplicando el Fixup. |
| Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction) | Convierte el documento y guarda errores en el archivo especificado. |
| Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction) | Convierte el documento y guarda errores en el archivo especificado. |
| ConvertPageToPNGMemoryStream(Page) | Convierte la página a PNG para DSR, OMR, flujo de imagen OCR. |
| Decrypt() | Desencripta el documento. Llame luego a Save para obtener la versión desencriptada del documento. |
| Dispose() | Cierra todos los recursos utilizados por este documento. |
| Encrypt(string, string, Permissions, CryptoAlgorithm) | Encripta el documento. Llame luego a Save para obtener la versión encriptada del documento. |
| Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool) | Encripta el documento. Llame luego a Save para obtener la versión encriptada del documento. |
| Encrypt(string, string, Permissions, CryptoAlgorithm, bool) | Encripta el documento. Llame luego a Save para obtener la versión encriptada del documento. |
| ExportAnnotationsToXfdf(Stream) | Exporta todas las anotaciones del documento al stream. |
| ExportAnnotationsToXfdf(string) | Exporta todas las anotaciones del documento a un archivo XFDF |
| Flatten() | Elimina todos los campos del documento y coloca sus valores en su lugar. |
| Flatten(FlattenSettings) | Elimina todos los campos (y anotaciones) del documento y coloca sus valores en su lugar. |
| FlattenTransparency() | Reemplaza el contenido transparente con gráficos raster y vectoriales no transparentes. |
| FreeMemory() | Limpia la memoria |
| GetCatalogValue(string) | Devuelve el valor del elemento del diccionario del catálogo. |
| GetObjectById(string) | Obtiene un objeto con el ID especificado en el documento. |
| GetXmpMetadata(Stream) | Obtiene metadatos XMP del documento. |
| HasIncrementalUpdate() | Verifica si el documento PDF actual ha sido guardado con actualizaciones incrementales. |
| ImportAnnotationsFromXfdf(Stream) | Importa anotaciones desde el stream al documento. |
| ImportAnnotationsFromXfdf(string) | Importa anotaciones desde un archivo XFDF al documento. |
| IsRepairNeeded(out RepairOptions) | Verifica si el documento requiere una llamada al método Repair. |
| LoadFrom(string, LoadOptions) | Carga un archivo, convirtiéndolo a PDF. |
| Merge(params Document[]) | Fusiona documentos. |
| Merge(params string[]) | Fusiona archivos pdf. |
| Merge(MergeOptions, params Document[]) | Fusiona documentos. |
| Merge(MergeOptions, params string[]) | Fusiona documentos. |
| Optimize() | Linealiza el documento para - abrir la primera página lo más rápido posible; - mostrar la siguiente página o seguir un enlace a la siguiente página lo más rápido posible; - mostrar la página de manera incremental a medida que llega cuando los datos de una página se entregan a través de un canal lento (mostrar los datos más útiles primero); - permitir la interacción del usuario, como seguir un enlace, que se realice incluso antes de que se haya recibido y mostrado toda la página. Invocar este método no guarda realmente el documento. Por el contrario, el documento solo se prepara para tener una estructura optimizada, llame luego a Save para obtener el documento optimizado. |
| OptimizeResources() | Optimiza los recursos en el documento: 1. Se eliminan los recursos que no se utilizan en las páginas del documento; 2. Los recursos iguales se unen en un objeto; 3. Se eliminan los objetos no utilizados. |
| OptimizeResources(OptimizationOptions) | Optimiza los recursos en el documento de acuerdo con la estrategia de optimización definida. |
| PageNodesToBalancedTree(byte) | Organiza los nodos del árbol de páginas en un documento en un árbol equilibrado. Solo si el documento tiene más de nodesNumInSubtrees objetos de página, de lo contrario no hace nada. No llame a este método mientras itera sobre los elementos de Pages, puede dar resultados impredecibles |
| ProcessParagraphs() | Procesa párrafos para el generador. |
| RemoveMetadata() | Elimina metadatos del documento. |
| RemovePdfaCompliance() | Elimina la conformidad pdfa del documento |
| RemovePdfUaCompliance() | Elimina la conformidad pdfUa del documento |
| Repair(RepairOptions) | Repara el documento dañado. |
| Save() | Guarda el documento de manera incremental (es decir, utilizando la técnica de actualización incremental). |
| Save(SaveOptions) | Guarda el documento con opciones de guardado. |
| Save(Stream) | Almacena el documento en el stream. |
| Save(string) | Guarda el documento en el archivo especificado. |
| Save(Stream, SaveFormat) | Guarda el documento con un nuevo nombre junto con un formato de archivo. |
| Save(Stream, SaveOptions) | Guarda el documento en un stream con opciones de guardado. |
| Save(string, SaveFormat) | Guarda el documento con un nuevo nombre junto con un formato de archivo. |
| Save(string, SaveOptions) | Guarda el documento con un nuevo nombre estableciendo sus opciones de guardado. |
| SaveAsync(CancellationToken) | Guarda el documento de manera incremental (es decir, utilizando la técnica de actualización incremental). |
| SaveAsync(SaveOptions, CancellationToken) | Guarda el documento con opciones de guardado. |
| SaveAsync(Stream, CancellationToken) | Almacena el documento en el stream. |
| SaveAsync(string, CancellationToken) | Guarda el documento en el archivo especificado. |
| SaveAsync(Stream, SaveFormat, CancellationToken) | Guarda el documento con un nuevo nombre junto con un formato de archivo. |
| SaveAsync(Stream, SaveOptions, CancellationToken) | Guarda el documento en un stream con opciones de guardado. |
| SaveAsync(string, SaveFormat, CancellationToken) | Guarda el documento con un nuevo nombre junto con un formato de archivo. |
| SaveAsync(string, SaveOptions, CancellationToken) | Guarda el documento con un nuevo nombre estableciendo sus opciones de guardado. |
| SaveXml(string) | Guarda el documento en XML. |
| SendTo(DocumentDevice, Stream) | Envía todo el documento al dispositivo de documento para su procesamiento. |
| SendTo(DocumentDevice, string) | Envía todo el documento al dispositivo de documento para su procesamiento. |
| SendTo(DocumentDevice, int, int, Stream) | Envía ciertas páginas del documento al dispositivo de documento para su procesamiento. |
| SendTo(DocumentDevice, int, int, string) | Envía todo el documento al dispositivo de documento para su procesamiento. |
| SetTitle(string) | Establece el Título para el Documento Pdf |
| SetXmpMetadata(Stream) | Establece los metadatos XMP del documento. |
| Validate(PdfFormatConversionOptions) | Valida el documento en el archivo especificado. |
| Validate(Stream, PdfFormat) | Valida el documento en el archivo especificado. |
| Validate(string, PdfFormat) | Valida el documento en el archivo especificado. |
| static Convert(Stream, LoadOptions, Stream, SaveOptions) | Convierte el stream en formato fuente en un stream en formato de destino. |
| static Convert(Stream, LoadOptions, string, SaveOptions) | Convierte el stream en formato fuente en un archivo de destino en formato de destino. |
| static Convert(string, LoadOptions, Stream, SaveOptions) | Convierte el archivo fuente en formato fuente en un stream en formato de destino. |
| static Convert(string, LoadOptions, string, SaveOptions) | Convierte el archivo fuente en formato fuente en un archivo de destino en formato de destino. |
| static SetDefaultFileSizeLimitToMemoryLoading() | Establece el límite de tamaño de archivo para cargar un archivo completo en memoria al valor predeterminado que equivale a 210 Mb. |
Campos
| Nombre | Descripción |
|---|---|
| const DefaultNodesNumInSubtrees |
Eventos
| Nombre | Descripción |
|---|---|
| event FontSubstitution | Ocurre cuando una fuente reemplaza a otra fuente en el documento. |
Otros Miembros
| Nombre | Descripción |
|---|---|
| delegate CallBackGetHocr | |
| delegate CallBackGetHocrWithPage | |
| delegate FontSubstitutionHandler | Representa el método que manejará el evento FontSubstitution. |
| interface IDocumentFontUtilities | Contiene funcionalidad para ajustar fuentes |
| class MergeOptions | Representa las opciones para los métodos de fusión. |
| class RepairOptions | Representa opciones para reparar un documento PDF. |
Véase También
- namespace Aspose.Pdf
- assembly Aspose.PDF
