Class Document
Namespace: Aspose.Pdf
Assembly: Aspose.PDF.dll
Clase que representa un documento PDF
public sealed class Document : IDisposableHerencia
Implementa
Miembros heredados
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Constructores
Document(Stream)
Inicializa una nueva instancia de Document a partir del flujo input.
public Document(Stream input)Parámetros
input Stream
Flujo con el documento pdf.
Document(Stream, string, bool)
Inicializa una nueva instancia de Document a partir del flujo input.
public Document(Stream input, string password, bool isManagedStream)Parámetros
input Stream
Flujo con el documento pdf.
password string
Contraseña de usuario o propietario.
isManagedStream bool
si se establece en true el flujo interno se cierra antes de salir; de lo contrario, no.
Document(Stream, bool)
Inicializa una nueva instancia de Document a partir del flujo input.
public Document(Stream input, bool isManagedStream)Parámetros
input Stream
Flujo con el documento pdf.
isManagedStream bool
si se establece en true el flujo interno se cierra antes de salir; de lo contrario, no.
Document(string)
Solo inicializa Document usando filename. Igual que Aspose.Pdf.Document.#ctor(System.IO.Stream).
public Document(string filename)Parámetros
filename string
El nombre del archivo del documento pdf.
Document(Stream, string)
Inicializa una nueva instancia de Document a partir del flujo input.
public Document(Stream input, string password)Parámetros
input Stream
Objeto de flujo de entrada, el pdf está protegido por contraseña.
password string
Contraseña de usuario o propietario.
Document()
Inicializa un documento vacío.
public Document()Document(string, string)
Inicializa una nueva instancia de la clase Aspose.Pdf.Document para trabajar con documentos encriptados.
public Document(string filename, string password)Parámetros
filename string
Nombre del archivo del documento.
password string
Contraseña de usuario o propietario.
Document(string, string, bool)
Inicializa una nueva instancia de la clase Aspose.Pdf.Document para trabajar con documentos encriptados.
public Document(string filename, string password, bool isManagedStream)Parámetros
filename string
Nombre del archivo del documento.
password string
Contraseña de usuario o propietario.
isManagedStream bool
si se establece en true el flujo interno se cierra antes de salir; de lo contrario, no.
Document(string, LoadOptions)
Abre un documento existente desde un archivo proporcionando las opciones necesarias de conversión para obtener un documento pdf.
public Document(string filename, LoadOptions options)Parámetros
filename string
Archivo de entrada para convertir en documento pdf.
options LoadOptions
Representa propiedades para convertir filename en documento pdf.
Document(Stream, LoadOptions)
Abre un documento existente desde un flujo proporcionando la conversión necesaria para obtener un documento pdf.
public Document(Stream input, LoadOptions options)Parámetros
input Stream
Flujo de entrada para convertir en documento pdf.
options LoadOptions
Representa propiedades para convertir input en documento pdf.
Campos
DefaultNodesNumInSubtrees
public const byte DefaultNodesNumInSubtrees = 10Valor del campo
Propiedades
Actions
Obtiene las acciones del documento. Esta propiedad es una instancia de la clase DocumentActions que permite obtener/establecer acciones BeforClosing, BeforSaving, etc.
public DocumentActionCollection Actions { get; }Valor de la propiedad
DocumentActionCollection
Ejemplos
Este ejemplo demuestra cómo obtener la acción después de abrir el documento:
Aspose.Pdf.Document document = new Aspose.Pdf.Document("d:\\work\\aspose\\aspose.pdf.kit.net.new\\trunk\\testdata\\Aspose.Pdf\\PdfWithOpenAction.pdf");
Aspose.Pdf.Annotations.DocumentActionCollection actions = document.Actions;
Aspose.Pdf.Annotations.PdfAction afterSavingAction = actions.AfterSaving;AllowReusePageContent
Permite fusionar contenidos de página para optimizar el tamaño del documento. Si se usa, entonces diferentes páginas 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.
public bool AllowReusePageContent { get; set; }Valor de la propiedad
Background
Obtiene o establece el color de fondo del documento.
public Color Background { get; set; }Valor de la propiedad
Color
CenterWindow
Obtiene o establece un indicador que especifica si la posición de la ventana del documento se centrará en la pantalla.
public bool CenterWindow { get; set; }Valor de la propiedad
Ejemplos
El ejemplo demuestra cómo obtener el indicador CenterWindow:
Document document = new Document("sample.pdf");
bool value = document.CenterWindow;Collection
Obtiene la colección del documento.
public Collection Collection { get; set; }Valor de la propiedad
Collection
CryptoAlgorithm
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.
public CryptoAlgorithm? CryptoAlgorithm { get; }Valor de la propiedad
CryptoAlgorithm?
Destinations
Obtiene la colección de destinos. Obsoleto. Por favor, use NamedDestinations.
public DestinationCollection Destinations { get; }Valor de la propiedad
DestinationCollection
Direction
Obtiene o establece el orden de lectura del texto: L2R (de izquierda a derecha) o R2L (de derecha a izquierda).
public Direction Direction { get; set; }Valor de la propiedad
Direction
DisableFontLicenseVerifications
Muchas operaciones con fuentes no se pueden ejecutar si estas operaciones están prohibidas por la licencia de esta fuente. Por ejemplo, algunas fuentes no se pueden incrustar en el documento PDF si las reglas de la 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. Así que 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.
public bool DisableFontLicenseVerifications { get; set; }Valor de la propiedad
DisplayDocTitle
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.
public bool DisplayDocTitle { get; set; }Valor de la propiedad
Ejemplos
El ejemplo demuestra cómo obtener el indicador DisplayDocTitle:
Document document = new Document("sample.pdf");
bool value = document.DisplayDocTitle;Duplex
Obtiene o establece la opción de manejo del modo de impresión dúplex que se utilizará al imprimir el archivo desde el cuadro de diálogo de impresión.
public PrintDuplex Duplex { get; set; }Valor de la propiedad
PrintDuplex
EmbedStandardFonts
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 se pueden incrustar 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.
public bool EmbedStandardFonts { get; set; }Valor de la propiedad
EmbeddedFiles
Obtiene la colección de archivos incrustados en el documento.
public EmbeddedFileCollection EmbeddedFiles { get; }Valor de la propiedad
EmbeddedFileCollection
EnableObjectUnload
Obtiene o establece un indicador que permite que el documento se descargue parcialmente de la memoria. Esto permite reducir el uso de memoria, pero puede tener un efecto negativo en el rendimiento.
public bool EnableObjectUnload { get; set; }Valor de la propiedad
EnableSignatureSanitization
Obtiene o establece un indicador para gestionar la sanitización de campos de firma. Habilitado por defecto.
public bool EnableSignatureSanitization { get; set; }Valor de la propiedad
FileName
Nombre del archivo PDF que causó este documento
public string FileName { get; }Valor de la propiedad
FitWindow
Obtiene o establece un indicador que especifica si la ventana del documento debe ser redimensionada para ajustarse a la primera página mostrada.
public bool FitWindow { get; set; }Valor de la propiedad
Ejemplos
El ejemplo demuestra cómo obtener el indicador FitWindow:
Document document = new Document("sample.pdf");
bool value = document.FitWindow;FontUtilities
Instancia de IDocumentFontUtilities
public Document.IDocumentFontUtilities FontUtilities { get; }Valor de la propiedad
Document.IDocumentFontUtilities
Form
Obtiene el formulario Acro del documento.
public Form Form { get; }Valor de la propiedad
Form
HandleSignatureChange
Lanza una excepción si el documento se guarda con cambios y tiene firma
public bool HandleSignatureChange { get; set; }Valor de la propiedad
HideMenubar
Obtiene o establece un indicador que especifica si la barra de menú debe estar oculta cuando el documento está activo.
public bool HideMenubar { get; set; }Valor de la propiedad
Ejemplos
El ejemplo demuestra cómo obtener el indicador HideMenubar:
Document document = new Document("sample.pdf");
bool value = document.HideMenubar;HideToolBar
Obtiene o establece un indicador que especifica si la barra de herramientas debe estar oculta cuando el documento está activo.
public bool HideToolBar { get; set; }Valor de la propiedad
Ejemplos
El ejemplo demuestra cómo obtener el indicador HideToolBar:
Document document = new Document("sample.pdf");
bool value = document.HideToolBar;HideWindowUI
Obtiene o establece un indicador que especifica si los elementos de la interfaz de usuario deben estar ocultos cuando el documento está activo.
public bool HideWindowUI { get; set; }Valor de la propiedad
Ejemplos
El ejemplo demuestra cómo obtener el indicador HideWindowUI:
Document document = new Document("sample.pdf");
bool value = document.HideWindowUI;Id
Obtiene el ID.
public Id Id { get; }Valor de la propiedad
Id
IgnoreCorruptedObjects
Obtiene o establece un indicador para ignorar errores en archivos fuente. Cuando se copian páginas del documento fuente al 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, los objetos corruptos se reemplazarán con valores vacíos. Por defecto: verdadero.
public bool IgnoreCorruptedObjects { get; set; }Valor de la propiedad
Info
Obtiene la información del documento.
public DocumentInfo Info { get; }Valor de la propiedad
DocumentInfo
IsEncrypted
Obtiene el estado de encriptación del documento. Verdadero si el documento está encriptado.
public bool IsEncrypted { get; }Valor de la propiedad
IsLicensed
Obtiene el estado de licencia del sistema. Devuelve verdadero si el sistema funciona en modo con licencia y falso en caso contrario.
public static bool IsLicensed { get; }Valor de la propiedad
IsLinearized
Obtiene o establece un valor que indica si el documento está linealizado.
public bool IsLinearized { get; set; }Valor de la propiedad
IsPdfUaCompliant
Obtiene si el documento cumple con pdfua.
public bool IsPdfUaCompliant { get; }Valor de la propiedad
IsPdfaCompliant
Obtiene si el documento cumple con pdfa.
public bool IsPdfaCompliant { get; }Valor de la propiedad
IsXrefGapsAllowed
Obtiene o establece si el documento permite huecos en el xref.
public bool IsXrefGapsAllowed { get; set; }Valor de la propiedad
JavaScript
Colección de JavaScript a nivel de documento.
public JavaScriptCollection JavaScript { get; }Valor de la propiedad
JavaScriptCollection
LogicalStructure
Obtiene la estructura lógica del documento.
public RootElement LogicalStructure { get; }Valor de la propiedad
RootElement
Metadata
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. Dicha información global sobre el documento (en contraposició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.)
public Metadata Metadata { get; }Valor de la propiedad
Metadata
NamedDestinations
Colección de Destinos Nombrados en el documento.
public NamedDestinationCollection NamedDestinations { get; }Valor de la propiedad
NamedDestinationCollection
NonFullScreenPageMode
Obtiene o establece el modo de página, especificando cómo mostrar el documento al salir del modo de pantalla completa.
public PageMode NonFullScreenPageMode { get; set; }Valor de la propiedad
PageMode
OpenAction
Obtiene o establece la acción realizada al abrir el documento.
public IAppointment OpenAction { get; set; }Valor de la propiedad
IAppointment
Ejemplos
El ejemplo demuestra cómo obtener el indicador CenterWindow:
Document document = new Document("sample.pdf");
IAppointment value = document.OpenAction;OptimizeSize
Obtiene o establece el indicador de optimización. Cuando se añaden páginas al documento, los flujos de recursos iguales en el archivo resultante se fusionan en un solo objeto PDF si este indicador está establecido. Esto permite reducir el tamaño del archivo resultante, pero puede causar una ejecución más lenta y mayores requisitos de memoria. Valor predeterminado: falso.
public bool OptimizeSize { get; set; }Valor de la propiedad
Outlines
Obtiene los contornos del documento.
public OutlineCollection Outlines { get; }Valor de la propiedad
OutlineCollection
OutputIntents
Obtiene la colección de Intenciones de Salida en el documento.
public OutputIntents OutputIntents { get; }Valor de la propiedad
OutputIntents
PageInfo
Obtiene o establece la información de la página.(solo para generador, no se llena al leer el documento)
public PageInfo PageInfo { get; set; }Valor de la propiedad
PageInfo
PageLabels
Obtiene las etiquetas de página en el documento.
public PageLabelCollection PageLabels { get; }Valor de la propiedad
PageLabelCollection
PageLayout
Obtiene o establece el diseño de página que se utilizará cuando se abra el documento.
public PageLayout PageLayout { get; set; }Valor de la propiedad
PageLayout
PageMode
Obtiene o establece el modo de página, especificando cómo debe mostrarse el documento al abrirse.
public PageMode PageMode { get; set; }Valor de la propiedad
PageMode
Pages
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.
public PageCollection Pages { get; }Valor de la propiedad
PageCollection
Ejemplos
El ejemplo a continuación demuestra cómo operar con las páginas del documento: Cómo obtener el número de páginas y cómo obtener el rectángulo de la página inicial del documento.
Aspose.Pdf.Document document = new Aspose.Pdf.Document("sample.pdf");
Aspose.Pdf.PageCollection pages = document.Pages;
System.Console.WriteLine("El documento contiene " + pages.Count);
Page page = pages[1];
Rectangle rect = page.Rect;PdfFormat
Obtiene el formato PDF
public PdfFormat PdfFormat { get; }Valor de la propiedad
PdfFormat
Permissions
Obtiene los permisos del documento.
public int Permissions { get; }Valor de la propiedad
PickTrayByPdfSize
Obtiene o establece un indicador que especifica si el tamaño de página PDF debe usarse para seleccionar la bandeja de papel de entrada.
public bool PickTrayByPdfSize { get; set; }Valor de la propiedad
PrintScaling
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.
public PrintScaling PrintScaling { get; set; }Valor de la propiedad
PrintScaling
TaggedContent
Obtiene acceso al contenido TaggedPdf.
public ITaggedContent TaggedContent { get; }Valor de la propiedad
ITaggedContent
Ejemplos
El ejemplo demuestra cómo usar contenido etiquetado para crear un nuevo documento con encabezado, párrafos e imágenes.
// Crear nuevo documento
Document document = new Document();
// Obtener el contenido etiquetado
ITaggedContent taggedContent = document.TaggedContent;
// Establecer el idioma para el documento
taggedContent.SetLanguage("en-US");
// Establecer el título para el documento PDF
taggedContent.SetTitle("Documento de ejemplo");
// Crear y añadir Sección
SectElement sect = taggedContent.CreateSectElement();
taggedContent.RootElement.AppendChild(sect);
// Crear Encabezado
HeaderElement h1 = taggedContent.CreateHeaderElement(1);
h1.SetText("El Encabezado");
sect.AppendChild(h1);
// Crear párrafo
ParagraphElement p = taggedContent.CreateParagraphElement();
p.SetTag("Paragraph");
p.SetText("El texto del párrafo.");
sect.AppendChild(p);
// Crear ilustración
IllustrationElement figure1 = taggedContent.CreateFigureElement();
sect.AppendChild(figure1);
figure1.AlternativeText = "Figura 1";
figure1.Title = "Imagen 1";
figure1.SetTag("Fig");
figure1.SetImage("ruta/de/la/imagen.jpg");
// Guardar documento
document.Save("example.pdf");Version
Obtiene una versión de Pdf desde el encabezado del archivo Pdf.
public string Version { get; }Valor de la propiedad
Métodos
BindXml(string)
Vincula xml al documento
public void BindXml(string file)Parámetros
file string
El archivo xml
BindXml(string, string)
Vincula xml/xsl al documento
public void BindXml(string xmlFile, string xslFile)Parámetros
xmlFile string
El archivo xml.
xslFile string
El archivo xsl si se usa XSLT.
BindXml(Stream, Stream)
Vincula xml/xsl al documento
public void BindXml(Stream xmlStream, Stream xslStream)Parámetros
xmlStream Stream
El flujo xml.
xslStream Stream
El flujo xsl si se usa XSLT.
BindXml(Stream, Stream, XmlReaderSettings)
Vincula xml/xsl al documento
public void BindXml(Stream xmlStream, Stream xslStream, XmlReaderSettings settings)Parámetros
xmlStream Stream
El flujo xml.
xslStream Stream
El flujo xsl si se usa XSLT.
settings XmlReaderSettings
La configuración del lector xml.
BindXml(Stream)
Vincula xml al documento
public void BindXml(Stream stream)Parámetros
stream Stream
El flujo xml.
ChangePasswords(string, string, string)
Cambia las contraseñas del documento. Esta acción solo se puede realizar utilizando la contraseña del propietario.
public void ChangePasswords(string ownerPassword, string newUserPassword, string newOwnerPassword)Parámetros
ownerPassword string
Contraseña del propietario.
newUserPassword string
Nueva contraseña de usuario.
newOwnerPassword string
Nueva contraseña de propietario.
Check(bool)
Valida el documento.
public bool Check(bool doRepair)Parámetros
doRepair bool
Si es verdadero, los problemas encontrados serán reparados.
Devuelve
Verdadero - si el documento fue reparado; de lo contrario, falso.
Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Convierte el documento y guarda los errores en el archivo especificado.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)Parámetros
outputLogFileName string
Ruta al archivo donde se almacenarán los comentarios.
format PdfFormat
El formato pdf.
action ConvertErrorAction
Acción para objetos que no se pueden convertir
transparencyAction ConvertTransparencyAction
Acción para objetos de imagen enmascarados
Devuelve
El resultado de la operación
Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Convierte el documento y guarda los errores en el archivo especificado.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)Parámetros
outputLogStream Stream
Flujo donde se almacenarán los comentarios.
format PdfFormat
El formato pdf.
action ConvertErrorAction
Acción para objetos que no se pueden convertir
transparencyAction ConvertTransparencyAction
Acción para objetos de imagen enmascarados
Devuelve
El resultado de la operación
Convert(string, PdfFormat, ConvertErrorAction)
Convierte el documento y guarda los errores en el archivo especificado.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action)Parámetros
outputLogFileName string
Ruta al archivo donde se almacenarán los comentarios.
format PdfFormat
El formato pdf.
action ConvertErrorAction
Acción para objetos que no se pueden convertir
Devuelve
El resultado de la operación
Convert(PdfFormatConversionOptions)
Convierte el documento utilizando las opciones de conversión especificadas.
public bool Convert(PdfFormatConversionOptions options)Parámetros
options PdfFormatConversionOptions
conjunto de opciones para convertir el documento PDF
Devuelve
El resultado de la operación
Convert(CallBackGetHocrWithPage, bool)
Reconoce imágenes dentro del documento y añade cadenas hocr sobre ellas.
public bool Convert(Document.CallBackGetHocrWithPage callback, bool flattenImages = false)Parámetros
callback Document.CallBackGetHocrWithPage
Acción para imágenes que serán procesadas por el reconocimiento hocr.
flattenImages bool
El texto en las imágenes pdf puede pintarse utilizando la mecánica de máscaras, en cuyo caso las imágenes deben ser aplanadas.
Devuelve
El resultado de la operación. Si no hay imágenes en el documento, devuelve falso.
Convert(CallBackGetHocr, bool)
Reconoce imágenes dentro del documento y añade cadenas hocr sobre ellas.
public bool Convert(Document.CallBackGetHocr callback, bool flattenImages = false)Parámetros
callback Document.CallBackGetHocr
Acción para imágenes que serán procesadas por el reconocimiento hocr.
flattenImages bool
El texto en las imágenes pdf puede pintarse utilizando la mecánica de máscaras, en cuyo caso las imágenes deben ser aplanadas.
Devuelve
El resultado de la operación. Si no hay imágenes en el documento, devuelve falso.
Convert(Stream, PdfFormat, ConvertErrorAction)
Convierte el documento y guarda los errores en el flujo especificado.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action)Parámetros
outputLogStream Stream
Flujo donde se almacenarán los comentarios.
format PdfFormat
Formato pdf.
action ConvertErrorAction
Acción para objetos que no se pueden convertir
Devuelve
El resultado de la operación
Convert(Fixup, Stream, bool, object[])
Convierte el documento aplicando el Fixup.
public bool Convert(Fixup fixup, Stream outputLog, bool onlyValidation = false, object[] parameters = null)Parámetros
fixup Fixup
El tipo de Fixup.
outputLog Stream
El registro del proceso.
onlyValidation bool
Solo validación del documento.
parameters object[]
Propiedades para Fixup que no se pueden establecer.
Devuelve
El resultado de la operación.
Convert(Fixup, string, bool, object[])
Convierte el documento aplicando el Fixup.
public bool Convert(Fixup fixup, string outputLog, bool onlyValidation = false, object[] parameters = null)Parámetros
fixup Fixup
El tipo de Fixup.
outputLog string
El registro del proceso.
onlyValidation bool
Solo validación del documento.
parameters object[]
Propiedades para Fixup que no se pueden establecer.
Devuelve
El resultado de la operación.
Convert(string, LoadOptions, string, SaveOptions)
Convierte el archivo fuente en formato fuente en un archivo de destino en formato de destino.
public static void Convert(string srcFileName, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)Parámetros
srcFileName string
El nombre del archivo fuente.
loadOptions LoadOptions
El formato del archivo fuente.
dstFileName string
El nombre del archivo de destino.
saveOptions SaveOptions
El formato del archivo de destino.
Convert(Stream, LoadOptions, string, SaveOptions)
Convierte el flujo en formato fuente en un archivo de destino en formato de destino.
public static void Convert(Stream srcStream, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)Parámetros
srcStream Stream
El flujo fuente.
loadOptions LoadOptions
El formato del flujo fuente.
dstFileName string
El nombre del archivo de destino.
saveOptions SaveOptions
El formato del archivo de destino.
Convert(string, LoadOptions, Stream, SaveOptions)
Convierte el archivo fuente en formato fuente en un flujo en formato de destino.
public static void Convert(string srcFileName, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)Parámetros
srcFileName string
El nombre del archivo fuente.
loadOptions LoadOptions
El formato del archivo fuente.
dstStream Stream
El flujo de destino.
saveOptions SaveOptions
El formato del flujo de destino.
Convert(Stream, LoadOptions, Stream, SaveOptions)
Convierte el flujo en formato fuente en un flujo en formato de destino.
public static void Convert(Stream srcStream, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)Parámetros
srcStream Stream
El flujo fuente.
loadOptions LoadOptions
El formato del flujo fuente.
dstStream Stream
El flujo de destino.
saveOptions SaveOptions
El formato del archivo de destino.
ConvertPageToPNGMemoryStream(Page)
Convierte la página a PNG para DSR, OMR, flujo de imagen OCR.
public MemoryStream ConvertPageToPNGMemoryStream(Page page)Parámetros
page Page
Página a convertir.
Devuelve
Flujo de imagen.
Decrypt()
Desencripta el documento. Luego llame a Save para obtener la versión desencriptada del documento.
public void Decrypt()Dispose()
Cierra todos los recursos utilizados por este documento.
public void Dispose()Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool)
Encripta el documento. Luego llame a Save para obtener la versión encriptada del documento.
public void Encrypt(string userPassword, string ownerPassword, DocumentPrivilege privileges, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)Parámetros
userPassword string
Contraseña de usuario.
ownerPassword string
Contraseña de propietario.
privileges DocumentPrivilege
Permisos del documento, consulte Aspose.Pdf.Document.Permissions para más detalles.
cryptoAlgorithm CryptoAlgorithm
Algoritmo criptográfico, consulte Aspose.Pdf.Document.CryptoAlgorithm para más detalles.
usePdf20 bool
Soporte para la revisión 6 (Extensión 8).
Encrypt(string, string, Permissions, CryptoAlgorithm)
Encripta el documento. Luego llame a Save para obtener la versión encriptada del documento.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm)Parámetros
userPassword string
Contraseña de usuario.
ownerPassword string
Contraseña de propietario.
permissions Permissions
Permisos del documento, consulte Aspose.Pdf.Document.Permissions para más detalles.
cryptoAlgorithm CryptoAlgorithm
Algoritmo criptográfico, consulte Aspose.Pdf.Document.CryptoAlgorithm para más detalles.
Encrypt(string, string, Permissions, CryptoAlgorithm, bool)
Encripta el documento. Luego llame a Save para obtener la versión encriptada del documento.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)Parámetros
userPassword string
Contraseña de usuario.
ownerPassword string
Contraseña de propietario.
permissions Permissions
Permisos del documento, consulte Aspose.Pdf.Document.Permissions para más detalles.
cryptoAlgorithm CryptoAlgorithm
Algoritmo criptográfico, consulte Aspose.Pdf.Document.CryptoAlgorithm para más detalles.
usePdf20 bool
Soporte para la revisión 6 (Extensión 8).
ExportAnnotationsToXfdf(string)
Exporta todas las anotaciones del documento a un archivo XFDF
public void ExportAnnotationsToXfdf(string fileName)Parámetros
fileName string
Nombre del archivo XFDF
ExportAnnotationsToXfdf(Stream)
Exporta todas las anotaciones del documento en un flujo.
public void ExportAnnotationsToXfdf(Stream stream)Parámetros
stream Stream
Flujo donde almacenar XFDF.
Flatten()
Elimina todos los campos del documento y coloca sus valores en su lugar.
public void Flatten()Flatten(FlattenSettings)
Elimina todos los campos (y anotaciones) del documento y coloca sus valores en su lugar.
public void Flatten(Form.FlattenSettings flattenSettings)Parámetros
flattenSettings Form.FlattenSettings
Configuraciones para el proceso de aplanamiento.
FlattenTransparency()
Reemplaza el contenido transparente con gráficos raster y vectoriales no transparentes.
public void FlattenTransparency()FreeMemory()
Limpia la memoria
public void FreeMemory()GetCatalogValue(string)
Devuelve el valor del elemento del diccionario de catálogo.
public object GetCatalogValue(string key)Parámetros
key string
La clave del elemento.
Devuelve
Valor del elemento - si la clave se encontró con éxito; de lo contrario, null.
GetObjectById(string)
Obtiene un objeto con el ID especificado en el documento.
public object GetObjectById(string id)Parámetros
id string
El id del objeto.
Devuelve
El objeto con el id especificado. Null si no se encuentra el id.
GetXmpMetadata(Stream)
Obtiene los metadatos XMP del documento.
public void GetXmpMetadata(Stream stream)Parámetros
stream Stream
Flujo donde se almacenarán los metadatos.
HasIncrementalUpdate()
Verifica si el documento PDF actual ha sido guardado con actualizaciones incrementales.
public bool HasIncrementalUpdate()Devuelve
true si el documento PDF tiene actualizaciones incrementales; de lo contrario, false.
ImportAnnotationsFromXfdf(string)
Importa anotaciones desde un archivo XFDF al documento.
public void ImportAnnotationsFromXfdf(string fileName)Parámetros
fileName string
Nombre del archivo XFDF
ImportAnnotationsFromXfdf(Stream)
Importa anotaciones desde un flujo al documento.
public void ImportAnnotationsFromXfdf(Stream stream)Parámetros
stream Stream
Flujo que contiene datos XFDF.
LoadFrom(string, LoadOptions)
Carga un archivo, convirtiéndolo a PDF.
public void LoadFrom(string filename, LoadOptions options)Parámetros
filename string
La ruta al archivo que se abrirá.
options LoadOptions
Las opciones de carga.
Excepciones
PdfException
Si no se puede cargar el archivo.
Si no se encuentra el archivo.
Merge(MergeOptions, params Document[])
Fusiona documentos.
public void Merge(Document.MergeOptions mergeOptions, params Document[] documents)Parámetros
mergeOptions Document.MergeOptions
Las opciones de fusión.
documents Document[]
Los documentos a fusionar.
Merge(MergeOptions, params string[])
Fusiona documentos.
public void Merge(Document.MergeOptions mergeOptions, params string[] files)Parámetros
mergeOptions Document.MergeOptions
Las opciones de fusión.
files string[]
Los archivos pdf a fusionar.
Merge(params Document[])
Fusiona documentos.
public void Merge(params Document[] documents)Parámetros
documents Document[]
Los documentos a fusionar.
Merge(params string[])
Fusiona archivos pdf.
public void Merge(params string[] files)Parámetros
files string[]
Los archivos pdf a fusionar.
MergeDocuments(MergeOptions, params string[])
Fusiona documentos.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params string[] files)Parámetros
mergeOptions Document.MergeOptions
Las opciones de fusión.
files string[]
Los archivos pdf a fusionar.
Devuelve
El documento fusionado.
MergeDocuments(MergeOptions, params Document[])
Fusiona documentos.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params Document[] files)Parámetros
mergeOptions Document.MergeOptions
files Document[]
Los documentos a fusionar.
Devuelve
El documento fusionado.
MergeDocuments(params string[])
Fusiona archivos pdf.
public static Document MergeDocuments(params string[] files)Parámetros
files string[]
Los archivos pdf a fusionar.
Devuelve
El documento fusionado.
MergeDocuments(params Document[])
Fusiona documentos.
public static Document MergeDocuments(params Document[] documents)Parámetros
documents Document[]
Los documentos a fusionar.
Devuelve
El documento fusionado.
Optimize()
Lineariza 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 forma 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 un documento optimizado.
public void Optimize()OptimizeResources()
Optimiza los recursos en el documento:
- Se eliminan los recursos que no se utilizan en las páginas del documento;
- Los recursos iguales se unen en un solo objeto;
- Se eliminan los objetos no utilizados.
public void OptimizeResources()OptimizeResources(OptimizationOptions)
Optimiza los recursos en el documento de acuerdo con la estrategia de optimización definida.
public void OptimizeResources(OptimizationOptions strategy)Parámetros
strategy OptimizationOptions
Estrategia de optimización.
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 elementos Pages, puede dar resultados impredecibles.
public void PageNodesToBalancedTree(byte nodesNumInSubtrees = 10)Parámetros
nodesNumInSubtrees byte
Número deseado de subnodos. El valor predeterminado es diez.
ProcessParagraphs()
Procesa párrafos para el generador.
public void ProcessParagraphs()RemoveMetadata()
Elimina los metadatos del documento.
public void RemoveMetadata()RemovePdfUaCompliance()
Elimina la conformidad pdfUa del documento.
public void RemovePdfUaCompliance()RemovePdfaCompliance()
Elimina la conformidad pdfa del documento.
public void RemovePdfaCompliance()Repair()
Repara un documento dañado.
public void Repair()Save(Stream)
Almacena el documento en un flujo.
public void Save(Stream output)Parámetros
output Stream
Flujo donde se almacenará el documento.
Save(string)
Guarda el documento en el archivo especificado.
public void Save(string outputFileName)Parámetros
outputFileName string
Ruta al archivo donde se almacenará el documento.
Save()
Guarda el documento de forma incremental (es decir, utilizando la técnica de actualización incremental).
public void Save()Observaciones
Para guardar el documento de forma incremental, debemos abrir el archivo del documento para escritura. Por lo tanto, el Documento debe inicializarse con un flujo escribible como en el siguiente fragmento de código: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // hacer algunos cambios y guardar el documento de forma incremental doc.Save();
Save(SaveOptions)
Guarda el documento con opciones de guardado.
public void Save(SaveOptions options)Parámetros
options SaveOptions
Opciones de guardado.
Save(string, SaveFormat)
Guarda el documento con un nuevo nombre junto con un formato de archivo.
public void Save(string outputFileName, SaveFormat format)Parámetros
outputFileName string
Ruta al archivo donde se almacenará el documento.
format SaveFormat
Opciones de formato.
Save(Stream, SaveFormat)
Guarda el documento con un nuevo nombre junto con un formato de archivo.
public void Save(Stream outputStream, SaveFormat format)Parámetros
outputStream Stream
Flujo donde se almacenará el documento.
format SaveFormat
Opciones de formato.
Excepciones
System.ArgumentException cuando se pasa Aspose.Pdf.HtmlSaveOptions a un método. Guardar un documento en el flujo html no es compatible. Por favor, use el método guardar en el archivo.
Save(string, SaveOptions)
Guarda el documento con un nuevo nombre configurando sus opciones de guardado.
public void Save(string outputFileName, SaveOptions options)Parámetros
outputFileName string
Ruta al archivo donde se almacenará el documento.
options SaveOptions
Opciones de guardado.
Save(Stream, SaveOptions)
Guarda el documento en un flujo con opciones de guardado.
public void Save(Stream outputStream, SaveOptions options)Parámetros
outputStream Stream
Flujo donde se almacenará el documento.
options SaveOptions
Opciones de guardado.
Excepciones
System.ArgumentException cuando se pasa Aspose.Pdf.HtmlSaveOptions a un método. Guardar un documento en el flujo html no es compatible. Por favor, use el método guardar en el archivo.
SaveAsync(Stream, CancellationToken)
Almacena el documento en un flujo.
public Task SaveAsync(Stream output, CancellationToken cancellationToken)Parámetros
output Stream
Flujo donde se almacenará el documento.
cancellationToken CancellationToken
Token de cancelación.
Devuelve
Tarea asincrónica.
SaveAsync(string, CancellationToken)
Guarda el documento en el archivo especificado.
public Task SaveAsync(string outputFileName, CancellationToken cancellationToken)Parámetros
outputFileName string
Ruta al archivo donde se almacenará el documento.
cancellationToken CancellationToken
Token de cancelación.
Devuelve
Tarea asincrónica.
SaveAsync(CancellationToken)
Guarda el documento de forma incremental (es decir, utilizando la técnica de actualización incremental).
public Task SaveAsync(CancellationToken cancellationToken)Parámetros
cancellationToken CancellationToken
Token de cancelación.
Devuelve
Tarea asincrónica.
Observaciones
Para guardar el documento de forma incremental debemos abrir el archivo del documento para escritura. Por lo tanto, el Documento debe inicializarse con un flujo escribible como en el siguiente fragmento de código: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // hacer algunos cambios y guardar el documento de forma incremental doc.Save();
SaveAsync(SaveOptions, CancellationToken)
Guarda el documento con opciones de guardado.
public Task SaveAsync(SaveOptions options, CancellationToken cancellationToken)Parámetros
options SaveOptions
Opciones de guardado.
cancellationToken CancellationToken
Token de cancelación.
Devuelve
Tarea asincrónica.
SaveAsync(string, SaveFormat, CancellationToken)
Guarda el documento con un nuevo nombre junto con un formato de archivo.
public Task SaveAsync(string outputFileName, SaveFormat format, CancellationToken cancellationToken)Parámetros
outputFileName string
Ruta al archivo donde se almacenará el documento.
format SaveFormat
Opciones de formato.
cancellationToken CancellationToken
Token de cancelación.
Devuelve
Tarea asincrónica.
SaveAsync(Stream, SaveFormat, CancellationToken)
Guarda el documento con un nuevo nombre junto con un formato de archivo.
public Task SaveAsync(Stream outputStream, SaveFormat format, CancellationToken cancellationToken)Parámetros
outputStream Stream
Flujo donde se almacenará el documento.
format SaveFormat
Opciones de formato.
cancellationToken CancellationToken
Token de cancelación.
Devuelve
Tarea asincrónica.
Excepciones
System.ArgumentException cuando se pasa Aspose.Pdf.HtmlSaveOptions a un método. Guardar un documento en el flujo html no es compatible. Por favor, use el método guardar en el archivo.
SaveAsync(string, SaveOptions, CancellationToken)
Guarda el documento con un nuevo nombre configurando sus opciones de guardado.
public Task SaveAsync(string outputFileName, SaveOptions options, CancellationToken cancellationToken)Parámetros
outputFileName string
Ruta al archivo donde se almacenará el documento.
options SaveOptions
Opciones de guardado.
cancellationToken CancellationToken
Token de cancelación.
Devuelve
Tarea asincrónica.
SaveAsync(Stream, SaveOptions, CancellationToken)
Guarda el documento en un flujo con opciones de guardado.
public Task SaveAsync(Stream outputStream, SaveOptions options, CancellationToken cancellationToken)Parámetros
outputStream Stream
Flujo donde se almacenará el documento.
options SaveOptions
Opciones de guardado.
cancellationToken CancellationToken
Token de cancelación.
Devuelve
Tarea asincrónica.
Excepciones
System.ArgumentException cuando se pasa Aspose.Pdf.HtmlSaveOptions a un método. Guardar un documento en el flujo html no es compatible. Por favor, use el método guardar en el archivo.
SaveXml(string)
Guarda el documento en XML.
public void SaveXml(string file)Parámetros
file string
El archivo xml del modelo del documento
SendTo(DocumentDevice, Stream)
Envía todo el documento al dispositivo de documento para su procesamiento.
public void SendTo(DocumentDevice device, Stream output)Parámetros
device DocumentDevice
Dispositivo de documento que se utiliza para procesar el documento.
output Stream
Flujo de salida que contiene los resultados del procesamiento del documento con el dispositivo dado.
SendTo(DocumentDevice, int, int, Stream)
Envía ciertas páginas del documento al dispositivo de documento para su procesamiento.
public void SendTo(DocumentDevice device, int fromPage, int toPage, Stream output)Parámetros
device DocumentDevice
Dispositivo de documento que se utiliza para procesar el documento.
fromPage int
La primera página para procesar.
toPage int
La última página para procesar.
output Stream
Flujo de salida que contiene los resultados del procesamiento de las páginas del documento con el dispositivo dado.
SendTo(DocumentDevice, string)
Envía todo el documento al dispositivo de documento para su procesamiento.
public void SendTo(DocumentDevice device, string outputFileName)Parámetros
device DocumentDevice
Dispositivo de documento que se utiliza para procesar el documento.
outputFileName string
Nombre del archivo de salida con los resultados del procesamiento.
SendTo(DocumentDevice, int, int, string)
Envía todo el documento al dispositivo de documento para su procesamiento.
public void SendTo(DocumentDevice device, int fromPage, int toPage, string outputFileName)Parámetros
device DocumentDevice
Dispositivo de documento que se utiliza para procesar el documento.
fromPage [int](https://learn.microsoft.com/dotnet/api/system.int32
