Documentize Namespace

Namespace: Documentize Assembly: Documentize.dll

Class DirectoryDataSource

Información

Representa los datos del directorio para operaciones de carga y guardado de un complemento.

public sealed class DirectoryDataSource : IDataSource

Herencia

object ← DirectoryDataSource

Implementa

IDataSource

Miembros heredados

Constructores

DirectoryDataSource(string)

Inicializa nuevos datos de directorio con la ruta especificada.

public DirectoryDataSource(string path)

Parámetros

path string: Una cadena que representa la ruta al directorio.

Propiedades

DataType

Tipo de fuente de datos.

public DataType DataType { get; }

Valor de la propiedad

Path

Obtiene la ruta al directorio de los datos actuales.

public string Path { get; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class DocConverter

Información

Representa el plugin Documentize.DocConverter. Se utiliza para convertir documentos PDF al formato DOC/DOCX.

public static class DocConverter

Herencia

object ← DocConverter

Miembros heredados

Ejemplos

El ejemplo demuestra cómo convertir un documento PDF al formato Doc.

// Crear objeto PdfToDocOptions para establecer instrucciones
var options = new PdfToDocOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// Realizar el proceso
DocConverter.Process(options);

El ejemplo demuestra cómo convertir un documento PDF al formato Doc configurando Modo.

// Crear objeto PdfToDocOptions para establecer instrucciones
var options = new PdfToDocOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// Establecer Modo
options.Mode = DocConversionMode.Flow;
// Realizar el proceso
DocConverter.Process(options);

Métodos

Process(PdfToDocOptions)

Convierte el documento PDF al formato DOC/DOCX.

public static ResultContainer Process(PdfToDocOptions options)

Parámetros

options PdfToDocOptions: Un objeto de opciones que contiene instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class EncryptionOptions

Información

Representa las opciones de cifrado para el complemento Documentize.Security.

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← EncryptionOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

EncryptionOptions(string, string)

Inicializa una nueva instancia del objeto Documentize.EncryptionOptions con opciones predeterminadas.

public EncryptionOptions(string ownerPassword, string userPassword)

Parámetros

ownerPassword string: Contraseña del propietario.
userPassword string: Contraseña del usuario.

Propiedades

OwnerPassword

Contraseña del propietario.

public string OwnerPassword { get; set; }

Valor de la propiedad

UserPassword

Contraseña del usuario.

public string UserPassword { get; set; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class ExtractFormDataToDsvOptions

Información

Representa opciones para exportar valores de campos para el plugin Documentize.PdfExtractor.

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

ExtractFormDataToDsvOptions(char, bool)

Inicializa una nueva instancia del objeto Documentize.ExtractFormDataToDsvOptions.

public ExtractFormDataToDsvOptions(char delimeter = ',', bool addFieldNames = false)

Parámetros

delimeter char: Especifica el delimitador a utilizar en los datos exportados entre valores. El valor predeterminado es ‘,’.
addFieldNames bool: Agrega el nombre del campo antes del valor. Formato: Nombre + delimitador + Valor + delimitador.

Propiedades

AddFieldName

Agrega el nombre del campo antes del valor. Formato: Nombre + delimitador + Valor + delimitador.

public bool AddFieldName { get; set; }

Valor de la propiedad

Delimeter

Delimitador utilizado para los valores exportados.

public char Delimeter { get; set; }

Valor de la propiedad

char

Namespace: Documentize Assembly: Documentize.dll

Class ExtractImagesOptions

Información

Representa las opciones de extracción de imágenes para el plugin Documentize.PdfExtractor.

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← ExtractImagesOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

ExtractImagesOptions()

Inicializa una nueva instancia del objeto Documentize.ExtractImagesOptions con opciones predeterminadas.

public ExtractImagesOptions()

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class ExtractTextOptions

Información

Representa opciones de extracción de texto para el plugin Documentize.PdfExtractor.

public sealed class ExtractTextOptions

Herencia

object ← ExtractTextOptions

Miembros heredados

Constructores

ExtractTextOptions(TextFormattingMode)

Inicializa una nueva instancia del objeto Documentize.ExtractTextOptions para el modo de formato de texto especificado.

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parámetros

formattingMode TextFormattingMode: Valor del modo de formato de texto.

Propiedades

FormattingMode

Obtiene el modo de formato.

public TextFormattingMode FormattingMode { get; set; }

Valor de la propiedad

TextFormattingMode

Inputs

Devuelve datos de Inputs para la operación.

public List<idatasource> Inputs { get; }

Valor de la propiedad

Métodos

AddInput(IDataSource)

Agrega nuevos datos a Inputs.

public void AddInput(IDataSource dataSource)

Parámetros

dataSource IDataSource: Fuente de datos a agregar. :

Namespace: Documentize Assembly: Documentize.dll

Class FileDataSource

Información

Representa datos de archivo para operaciones de carga y guardado de un plugin.

public sealed class FileDataSource : IDataSource

Herencia

object ← FileDataSource

Implementa

IDataSource

Miembros heredados

Constructores

FileDataSource(string)

Inicializa una nueva fuente de datos de archivo con la ruta especificada.

public FileDataSource(string path)

Parámetros

path string: Una cadena que representa la ruta al archivo fuente.

Propiedades

DataType

Tipo de fuente de datos.

public DataType DataType { get; }

Valor de la propiedad

Path

Obtiene la ruta al archivo de los datos actuales.

public string Path { get; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class FileResult

Información

Representa el resultado de una operación en forma de ruta de archivo de cadena.

public sealed class FileResult : IOperationResult

Herencia

object ← FileResult

Implementa

IOperationResult

Miembros heredados

Propiedades

Data

Obtiene datos en crudo.

public object Data { get; }

Valor de la propiedad

IsFile

Indica si el resultado es una ruta a un archivo de salida.

public bool IsFile { get; }

Valor de la propiedad

IsStream

Indica si el resultado es un flujo de salida.

public bool IsStream { get; }

Valor de la propiedad

IsString

Indica si el resultado es una cadena de texto.

public bool IsString { get; }

Valor de la propiedad

Métodos

ToFile()

Intenta convertir el resultado en un archivo.

public string ToFile()

Devuelve

string : Una cadena que representa la ruta al archivo de salida si el resultado es un archivo; de lo contrario, null.

ToStream()

Intenta convertir el resultado en un objeto de flujo.

public Stream ToStream()

Devuelve

Stream : Un objeto de flujo que representa los datos de salida si el resultado es un flujo; de lo contrario, null.

Namespace: Documentize Assembly: Documentize.dll

Class FormExporter

Información

Representa el plugin Documentize.FormExporter. Utilizado para exportar valores de formularios de documentos PDF a archivos DSV o CSV.

[Obsolete("Please use PdfExtractor class. The class will be deleted soon.")]
public static class FormExporter

Herencia

object ← FormExporter

Miembros heredados

Métodos

Process(ExtractFormDataToDsvOptions)

Inicia el procesamiento de Documentize.FormExporter con los parámetros especificados.

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

Parámetros

options ExtractFormDataToDsvOptions: Un objeto de opciones que contiene instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class FormExportToDsvOptions

Información

Representa opciones para exportar valores de campos para el plugin Documentize.FormExporter.

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← FormExportToDsvOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

FormExportToDsvOptions(char, bool)

Inicializa una nueva instancia del objeto Documentize.FormExportToDsvOptions.

public FormExportToDsvOptions(char delimeter = ',', bool addFieldNames = false)

Parámetros

delimeter char: Especifica el delimitador a usar en los datos exportados entre valores. El valor predeterminado es ‘,’.
addFieldNames bool: Añadir el nombre del campo antes del valor. Formato: Nombre + delimitador + Valor + delimitador.

Propiedades

AddFieldName

Añadir el nombre del campo antes del valor. Formato: Nombre + delimitador + Valor + delimitador.

public bool AddFieldName { get; set; }

Valor de Propiedad

Delimeter

Delimitador utilizado para los valores exportados.

public char Delimeter { get; set; }

Valor de Propiedad

char

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattener

Información

Representa el plugin Documentize.FormFlattener. Se utiliza para aplanar campos en documentos PDF.

public static class FormFlattener

Herencia

object ← FormFlattener

Miembros heredados

Ejemplos

El ejemplo demuestra cómo aplanar campos en un archivo PDF.

// Crear objeto FormFlattenerOptions para establecer instrucciones
var options = new FormFlattenerOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
FormFlattener.Process(options);

El ejemplo demuestra cómo aplanar campos en un archivo PDF y omitir el primer campo.

// Obtener nombres de campos
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// Crear objeto FormFlattenerOptions para establecer instrucciones
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Omitir 1 campo.
options.SkipFields.Add(fieldNames[0]);
// Realizar el proceso
FormFlattener.Process(options);

El ejemplo demuestra cómo obtener nombres de campos de un archivo PDF.

// Obtener nombres de campos
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

Métodos

GetFieldNames(string)

Obtener nombres de campos en el documento PDF.

public static List<string> GetFieldNames(string path)

Parámetros

path string: La ruta al documento PDF.

Devuelve

List<string>

Lista de nombres en el documento PDF.

GetFieldNames(Stream) : Obtener nombres de campos en el documento PDF.

public static List<string> GetFieldNames(Stream stream)

Parámetros

stream Stream: El flujo con el documento PDF.

Devuelve

List<string>

Lista de nombres en el documento PDF.

Process(FormFlattenerOptions) : Aplanar campos de formulario en el documento PDF.

public static ResultContainer Process(FormFlattenerOptions options)

Parámetros

options FormFlattenerOptions: Un objeto de opciones que contiene instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattenerOptions

Información

Representa opciones para Flatten Fields en documentos mediante el plugin Documentize.FormFlattener.

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← FormFlattenerOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

FormFlattenerOptions()

Inicializa una nueva instancia del objeto Documentize.FormFlattenerOptions con opciones predeterminadas.

public FormFlattenerOptions()

Propiedades

SkipFields

La lista de campos que no se aplanarán.

public List<string> SkipFields { get; set; }

Valor de la propiedad

List<string>

Namespace: Documentize Assembly: Documentize.dll

Class HtmlConverter

Información

Representa el plugin Documentize.HtmlConverter. Se utiliza para convertir documentos PDF en formato HTML y documentos HTML en formato PDF.

public static class HtmlConverter

Herencia

object ← HtmlConverter

Miembros heredados

Ejemplos

El ejemplo demuestra cómo convertir un documento PDF a HTML.

// Crear objeto PdfToHtmlOptions para establecer el tipo de datos de salida como archivo con recursos incrustados
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("ruta_del_input.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("ruta_del_output.html"));
// Realizar el proceso
HtmlConverter.Process(options);

El ejemplo demuestra cómo convertir un documento HTML a PDF.

// Crear HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("ruta_del_input.html"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("ruta_del_output.pdf"));
// Realizar el proceso
HtmlConverter.Process(options);

Métodos

Process(PdfToHtmlOptions)

Convierte documentos PDF en formato HTML.

public static ResultContainer Process(PdfToHtmlOptions options)

Parámetros

options PdfToHtmlOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Process(HtmlToPdfOptions)

Convierte documentos HTML en formato PDF.

public static ResultContainer Process(HtmlToPdfOptions options)

Parámetros

options HtmlToPdfOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class HtmlToPdfOptions

Información

Representa las opciones del convertidor de HTML a PDF para el plugin Documentize.HtmlConverter.

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← HtmlToPdfOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

HtmlToPdfOptions()

Inicializa una nueva instancia del objeto Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Propiedades

BasePath

La ruta/base URL para el archivo HTML.

public string BasePath { get; set; }

Valor de propiedad

HtmlMediaType

Obtiene o establece los posibles tipos de medios utilizados durante la representación.

public HtmlMediaType HtmlMediaType { get; set; }

Valor de propiedad

HtmlMediaType

IsRenderToSinglePage

Obtiene o establece la representación de todo el documento en una sola página.

public bool IsRenderToSinglePage { get; set; }

Valor de propiedad

PageInfo

Obtiene o establece la información de la página del documento.

public PageInfo PageInfo { get; set; }

Valor de propiedad

PageInfo

PageLayoutOption

Obtiene o establece la opción de diseño.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Valor de propiedad

HtmlPageLayoutOption

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractor

Información

Representa el plugin Documentize.ImageExtractor. Se utiliza para extraer imágenes de documentos PDF.

[Obsolete("Por favor, utilice la clase PdfExtractor. La clase será eliminada pronto.")]
public static class ImageExtractor

Herencia

object ← ImageExtractor

Miembros heredados

Métodos

Process(ExtractImagesOptions)

Extraer imágenes de documentos PDF.

public static ResultContainer Process(ExtractImagesOptions options)

Parámetros

options ExtractImagesOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractorOptions

Información

Representa las opciones de extracción de imágenes para el plugin Documentize.ImageExtractor.

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← ImageExtractorOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

ImageExtractorOptions()

Inicializa una nueva instancia del objeto Documentize.ImageExtractorOptions con opciones predeterminadas.

public ImageExtractorOptions()

Namespace: Documentize Assembly: Documentize.dll

Class JpegConverter

Información

Representa el plugin Documentize.JpegConverter. Se utiliza para convertir documentos PDF a formato JPEG.

public static class JpegConverter

Herencia

object ← JpegConverter

Miembros heredados

Ejemplos

El ejemplo demuestra cómo convertir un documento PDF a formato JPEG.

// Crear un objeto PdfToJpegOptions para establecer las instrucciones
var options = new PdfToJpegOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Establecer ruta del directorio de salida
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Realizar el proceso
JpegConverter.Process(options);

El ejemplo demuestra cómo convertir un documento PDF a formato JPEG con configuraciones para páginas, resolución y calidad.

// Crear un objeto PdfToJpegOptions para establecer las instrucciones
var options = new PdfToJpegOptions();
// Procesar solo la primera página
options.PageList = [1];
// Establecer la resolución de salida a 200 DPI
options.OutputResolution = 200;
// Establecer la calidad de salida a 50
options.Quality = 50;
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Establecer ruta del directorio de salida
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Realizar el proceso
JpegConverter.Process(options);

El ejemplo demuestra cómo convertir un documento PDF a formato JPEG a flujos.

// Crear un objeto PdfToJpegOptions para establecer las instrucciones
var options = new PdfToJpegOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Realizar el proceso
var results = JpegConverter.Process(options);
// Obtener resultados de flujo
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Métodos

Process(PdfToJpegOptions)

Convierte un documento PDF a formato JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Parámetros

options PdfToJpegOptions: Un objeto de opciones que contiene instrucciones para el Documentize.JpegConverter.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están establecidas.

Namespace: Documentize Assembly: Documentize.dll

Class MergeOptions

Información

Representa opciones de fusión para el complemento Documentize.PdfManager.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← MergeOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

MergeOptions()

Inicializa una nueva instancia del objeto Documentize.MergeOptions con opciones predeterminadas.

public MergeOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Merger

Información

Representa el plugin Documentize.Merger. Se utiliza para fusionar múltiples documentos PDF en un único PDF.

[Obsolete("Por favor, utiliza la clase PdfManager. La clase será eliminada pronto.")]
public static class Merger

Herencia

object ← Merger

Miembros heredados

Métodos

Process(MergeOptions)

Fusionar documentos PDF.

public static ResultContainer Process(MergeOptions options)

Parámetros

options MergeOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class Message

Información

Un mensaje de finalización de chat generado por el modelo.

public class Message

Herencia

object ← Message

Miembros heredados

Constructores

Message()

public Message()

Propiedades

Contenido

El contenido del mensaje.

[JsonProperty("content")]
public string Content { get; set; }

Valor de la propiedad

Rol

Establece o obtiene el rol del autor de este mensaje.

[JsonProperty("role")]
[JsonConverter(typeof(StringEnumConverter), new object[] { true })]
public Role Role { get; set; }

Valor de la propiedad

Role

Namespace: Documentize Assembly: Documentize.dll

Class ObjectResult

Información

Representa el resultado de la operación en forma de cadena.

public sealed class ObjectResult : IOperationResult

Inheritance

object ← ObjectResult

Implements

IOperationResult

Inherited Members

Properties

Data

Obtiene los datos en bruto.

public object Data { get; }

Property Value

IsFile

Indica si el resultado es una ruta a un archivo de salida.

public bool IsFile { get; }

Property Value

IsObject

Indica si el resultado es un objeto.

public bool IsObject { get; }

Property Value

IsStream

Indica si el resultado es una ruta a un archivo de salida.

public bool IsStream { get; }

Property Value

IsString

Indica si el resultado es una cadena.

public bool IsString { get; }

Property Value

Text

Devuelve la representación en cadena del resultado.

public string Text { get; }

Property Value

Methods

ToFile()

Intenta convertir el resultado a un archivo.

public string ToFile()

Returns

string : Una cadena que representa la ruta al archivo de salida si el resultado es un archivo; de lo contrario null.

ToStream()

Intenta convertir el resultado a un objeto de flujo.

public Stream ToStream()

Returns

Stream : Un objeto de flujo que representa los datos de salida si el resultado es un flujo; de lo contrario null.

ToString()

Intenta convertir el resultado a una cadena.

public override string ToString()

Returns

string : Una cadena que representa el contenido de texto si el resultado es una cadena; de lo contrario, devuelve base.ToString().

Namespace: Documentize Assembly: Documentize.dll

Class OptimizeOptions

Información

Representa opciones de optimización para el plugin Documentize.PdfManager.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← OptimizeOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

OptimizeOptions()

Inicializa una nueva instancia del objeto Documentize.OptimizeOptions con opciones predeterminadas. Lineariza el documento para

abrir la primera página lo más rápido posible;
mostrar la siguiente página o seguir por 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 para una página se entregan a través de un canal lento (mostrar primero los datos más útiles);
permitir la interacción del usuario, como seguir un enlace, incluso antes de que se haya recibido y mostrado toda la página.

public OptimizeOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Optimizer

Información

Representa el plugin Documentize.Optimizer. Se utiliza para Optimizar, Rotar, Redimensionar, Comprimir documentos PDF.

[Obsolete("Por favor, utiliza la clase PdfManager. La clase será eliminada pronto.")]
public static class Optimizer

Herencia

object ← Optimizer

Miembros heredados

Métodos

Process(OptimizeOptions)

Inicia el procesamiento de Documentize.Optimizer con los parámetros especificados.

public static ResultContainer Process(OptimizeOptions options)

Parámetros

options OptimizeOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Process(RotateOptions)

Inicia el procesamiento de Documentize.Optimizer con los parámetros especificados.

public static ResultContainer Process(RotateOptions options)

Parámetros

options RotateOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Process(ResizeOptions)

Inicia el procesamiento de Documentize.Optimizer con los parámetros especificados.

public static ResultContainer Process(ResizeOptions options)

Parámetros

options ResizeOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Process(CompressOptions)

Inicia el procesamiento de Documentize.Optimizer con los parámetros especificados.

public static ResultContainer Process(CompressOptions options)

Parámetros

options CompressOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Namespace: Documentize Assembly: Documentize.dll

Class PageInfo

Información

Representa la información de la página.

public class PageInfo : PageSize

Herencia

object ← PageSize ← PageInfo

Miembros heredados

Constructores

PageInfo()

Constructor de Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Constructor de Documentize.PageInfo.

public PageInfo(double width, double height)

Parámetros

width double: Ancho de la página.
height double: Alto de la página.

Propiedades

MarginBottom

Obtiene o establece un valor que indica el margen inferior.

public double MarginBottom { get; set; }

Valor de Propiedad

MarginLeft

Obtiene o establece un valor que indica el margen izquierdo.

public double MarginLeft { get; set; }

Valor de Propiedad

MarginRight

Obtiene o establece un valor que indica el margen derecho.

public double MarginRight { get; set; }

Valor de Propiedad

MarginTop

Obtiene o establece un valor que indica el margen superior.

public double MarginTop { get; set; }

Valor de Propiedad

Namespace: Documentize Assembly: Documentize.dll

Class PageSize

Información

Clase que representa el tamaño de la página en un documento PDF.

public class PageSize

Herencia

object ← PageSize

Derivados

PageInfo

Miembros heredados

Constructores

PageSize()

Constructor de Documentize.PageSize. Tamaños A4 por defecto.

public PageSize()

PageSize(double, double)

Constructor de Documentize.PageSize.

public PageSize(double width, double height)

Parámetros

width double: Ancho de la página.
height double: Altura de la página.

Propiedades

A0

Tamaño A0 (1189x840 mm).

public static PageSize A0 { get; }

Valor de la propiedad

A1

Tamaño A1 (840x594 mm).

public static PageSize A1 { get; }

Valor de la propiedad

A2

Tamaño A2 (594x420 mm).

public static PageSize A2 { get; }

Valor de la propiedad

A3

Tamaño A3 (420x297 mm).

public static PageSize A3 { get; }

Valor de la propiedad

A4

Tamaño A4 (297x210 mm).

public static PageSize A4 { get; }

Valor de la propiedad

A5

Tamaño A5 (210x148 mm).

public static PageSize A5 { get; }

Valor de la propiedad

A6

Tamaño A6 (148x105 mm).

public static PageSize A6 { get; }

Valor de la propiedad

B5

Tamaño B5 (250x176 mm).

public static PageSize B5 { get; }

Valor de la propiedad

Height

Obtiene o establece la altura de la página.

public double Height { get; set; }

Valor de la propiedad

IsLandscape

Obtiene la orientación de la página. Devuelve verdadero si esta es orientación apaisada y falso si es retrato.

public bool IsLandscape { get; }

Valor de la propiedad

P11x17

Formato 11x17 pulgadas.

public static PageSize P11x17 { get; }

Valor de la propiedad

PageLedger

Tamaño Ledger (432x279 mm).

public static PageSize PageLedger { get; }

Valor de la propiedad

PageLegal

Tamaño Legal (356x216 mm).

public static PageSize PageLegal { get; }

Valor de la propiedad

PageLetter

Tamaño Carta (279x216 mm).

public static PageSize PageLetter { get; }

Valor de la propiedad

Width

Obtiene o establece el ancho de la página.

public double Width { get; set; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConverter

Información

Representa un plugin para manejar la conversión de documentos PDF en un formato PDF/A y para la validación de la conformidad PDF/A.

public static class PdfAConverter

Inheritance

object ← PdfAConverter

Inherited Members

Examples

El ejemplo demuestra cómo convertir el documento PDF en un formato PDF/A (PDF/A-3b en este caso):

// Crear la clase de opciones para configurar el proceso de conversión
var options = new PdfAConvertOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Añadir el archivo fuente
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // reemplaza con la ruta de tu archivo real

// Añadir la ruta para guardar el archivo convertido
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));

// Ejecutar la conversión
PdfAConverter.Process(options);

El ejemplo demuestra cómo validar la conformidad del documento PDF con el formato PDF/A (PDF/A-1a en este caso):

// Crear la clase de opciones para configurar el proceso de validación
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Añadir uno o más archivos para validar
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // reemplaza con la ruta de tu archivo real
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// añade más archivos según sea necesario

// Ejecutar la validación y obtener resultados
var resultContainer = PdfAConverter.Process(options);

// Verifica la propiedad resultContainer.ResultCollection para los resultados de validación de cada archivo:
for (var i = 0; i &lt; resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Resultado de validación para el i-ésimo documento
}

Methods

Process(PdfAConvertOptions)

Convierte el documento PDF a formato PDF/A.

public static ResultContainer Process(PdfAConvertOptions options)

Parameters

options PdfAConvertOptions: Un objeto de opciones que contiene instrucciones para la operación.

Returns

ResultContainer : Un objeto que contiene el resultado de la operación.

Exceptions

Si no se establecen las opciones.

Process(PdfAValidateOptions)

Verifica el documento PDF para su conformidad con el formato especificado PDF/A.

public static ResultContainer Process(PdfAValidateOptions options)

Parameters

options PdfAValidateOptions: Un objeto de opciones que contiene instrucciones para la operación.

Returns

ResultContainer : Un objeto que contiene el resultado de la operación.

Exceptions

Si no se establecen las opciones.

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConvertOptions

Información

Representa las opciones para convertir documentos PDF al formato PDF/A con el plugin Documentize.PdfAConverter.

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Herencia

object ← PdfAOptionsBase ← PdfAConvertOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

PdfAConvertOptions()

public PdfAConvertOptions()

Propiedades

Outputs

Obtiene la colección de objetivos añadidos (fuentes de datos de archivo o de flujo) para los resultados de la operación de guardado.

public List<idatasource> Outputs { get; }

Valor de la propiedad

Métodos

AddOutput(IDataSource)

Añade un nuevo objetivo para guardar resultados.

public void AddOutput(IDataSource dataSource)

Parámetros

dataSource IDataSource: Objetivo (fuente de datos de archivo o de flujo) para guardar los resultados de la operación. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfAOptionsBase

Información

Representa la clase base para las opciones del complemento Documentize.PdfAConverter. Esta clase proporciona propiedades y métodos para configurar el proceso de conversión y validación de PDF/A.

public abstract class PdfAOptionsBase : IPluginOptions

Inheritance

object ← PdfAOptionsBase

Derived

Implements

IPluginOptions

Inherited Members

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Properties

AlignText

Obtiene o establece un valor que indica si se necesitan medios adicionales para preservar la alineación del texto durante el proceso de conversión a PDF/A.

public bool AlignText { get; set; }

Valor de la Propiedad

Observaciones

Cuando se establece en true, el proceso de conversión intentará restaurar los límites del segmento de texto original. Para la mayoría de los documentos, no es necesario cambiar esta propiedad del valor predeterminado false, ya que la alineación del texto no cambia durante el proceso de conversión predeterminado.

CheckDifferentNamesInFontDictionaries

Obtiene las banderas que controlan la conversión a PDF/A en los casos en que el documento PDF de origen no corresponde a la especificación PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Valor de la Propiedad

ErrorAction

Obtiene o establece la acción a tomar para los objetos que no se pueden convertir.

public ConvertErrorAction ErrorAction { get; set; }

Valor de la Propiedad

ConvertErrorAction

IccProfileFileName

Obtiene o establece el nombre del archivo del perfil ICC (Consorcio Internacional del Color) que se utilizará para la conversión a PDF/A en lugar del predeterminado.

public string IccProfileFileName { get; set; }

Valor de la Propiedad

Inputs

Obtiene la colección de fuentes de datos

public List<idatasource> Inputs { get; }

Valor de la Propiedad

IsLowMemoryMode

Obtiene o establece un valor que indica si el modo de baja memoria está habilitado durante el proceso de conversión a PDF/A.

public bool IsLowMemoryMode { get; set; }

Valor de la Propiedad

LogOutputSource

Obtiene o establece la fuente de datos para la salida del registro.

public IDataSource LogOutputSource { get; set; }

Valor de la Propiedad

IDataSource

OptimizeFileSize

Obtiene o establece un valor que indica si se debe intentar reducir el tamaño del archivo durante el proceso de conversión a PDF/A.

public bool OptimizeFileSize { get; set; }

Valor de la Propiedad

Observaciones

Cuando se establece en true, el proceso de conversión intentará minimizar el tamaño del archivo resultante. Esto podría afectar el rendimiento del proceso de conversión.

PdfAVersion

Obtiene o establece la versión de la norma PDF/A que se utilizará para la validación o conversión.

public PdfAStandardVersion PdfAVersion { get; set; }

Valor de la Propiedad

PdfAStandardVersion

Observaciones

La versión de la norma PDF/A se utiliza para determinar el nivel de cumplimiento para la validación y conversión de PDF/A. Si la versión se establece en Documentize.PdfAStandardVersion.Auto, el sistema determinará automáticamente la versión de norma PDF/A apropiada para la validación basada en los metadatos del documento. Para el proceso de conversión a PDF/A, Documentize.PdfAStandardVersion.Auto tiene como valor predeterminado la versión estándar PDF/A-1b.

SoftMaskAction

Obtiene o establece la acción que se llevará a cabo durante la conversión de imágenes con máscaras suaves.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Valor de la Propiedad

ConvertSoftMaskAction

Methods

AddInput(IDataSource)

Agrega una nueva fuente de datos a la colección

public void AddInput(IDataSource dataSource)

Parámetros

dataSource IDataSource:

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidateOptions

Información

Representa opciones para validar la conformidad con PDF/A de documentos PDF utilizando el complemento Documentize.PdfAConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Herencia

object ← PdfAOptionsBase ← PdfAValidateOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

PdfAValidateOptions()

public PdfAValidateOptions()

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidationResult

Información

Representa el resultado de un proceso de validación de PDF/A.

public sealed class PdfAValidationResult

Herencia

object ← PdfAValidationResult

Miembros heredados

Campos

DataSource Obtiene la fuente de datos que fue validada.

Valor del campo

IDataSource

IsValid

Obtiene un valor que indica si la validación fue exitosa.

public readonly bool IsValid

Valor del campo

ArgumentException : InvalidOperationException

StandardVersion

Obtiene la versión estándar de PDF/A utilizada para la validación.

public readonly PdfAStandardVersion StandardVersion

Valor del campo

PdfAStandardVersion

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGpt

Información

Representa el plugin PdfChatGpt.

public static class PdfChatGpt

Herencia

object ← PdfChatGpt

Miembros heredados

Ejemplos

El ejemplo demuestra cómo usar el plugin PdfChatGpt agregando mensajes a la solicitud.

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Agregar la ruta del archivo de salida.
options.ApiKey = "Your API key."; // Necesitas proporcionar la clave para acceder a la API.
options.MaxTokens = 1000; // El número máximo de tokens a generar en la finalización del chat.

// Agregar los mensajes de la solicitud.
options.Messages.Add(new Message
{
    Content = "You are a helpful assistant.",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "What is the biggest pizza diameter ever made?",
    Role = Role.User
});

// Procesar la solicitud.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // El objeto de finalización de chat de la API ChatGPT.

El ejemplo demuestra cómo usar el plugin PdfChatGpt agregando un mensaje a la solicitud.

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Agregar la ruta del archivo de salida.
options.ApiKey = "Your API key."; // Necesitas proporcionar la clave para acceder a la API.
options.MaxTokens = 1000; // El número máximo de tokens a generar en la finalización del chat.

// Agregar el mensaje de la solicitud.
// En este caso, el mensaje del sistema con Content = "You are a helpful assistant." se agrega por defecto.
// El rol del mensaje de consulta es "user" por defecto.
options.Query = "What is the lowest temperature recorded on the Earth?";

// Procesar la solicitud.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // El objeto de finalización de chat de la API ChatGPT.

El ejemplo demuestra cómo usar el plugin PdfChatGpt agregando archivos como fuente(s) de mensaje(s).

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Agregar la ruta del archivo de salida.

// Agregar la fuente de texto PDF.
// En caso de múltiples fuentes, el texto de cada documento se agregará a la colección de mensajes de la solicitud
// como un mensaje separado con el rol "user".
options.AddInput(new FileDataSource("TextSource.pdf"));

options.ApiKey = "Your API key."; // Necesitas proporcionar la clave para acceder a la API.
options.MaxTokens = 1000; // El número máximo de tokens a generar en la finalización del chat.

// Agregar el mensaje de la solicitud.
// En este caso, el mensaje del sistema con Content = "You are a helpful assistant." se agrega por defecto.
// El rol del mensaje de consulta es "user" por defecto.
options.Query = "How many letters in the provided text?";

// Procesar la solicitud.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // El objeto de finalización de chat de la API ChatGPT.

Observaciones

El Documentize.PdfChatGpt se utiliza para enviar solicitudes a ChatGPT directamente o mediante la adición de fuentes de archivos PDF y guardar la respuesta en la fuente de salida.

Métodos

Process(IPluginOptions)

El método no tiene versión sincrónica. Usa el método ProcessAsync en su lugar.

public static ResultContainer Process(IPluginOptions options)

Parámetros

options IPluginOptions: Un objeto de opciones que contiene instrucciones para el PdfChatGpt.

Retorna

ResultContainer : #### Excepciones

NotImplementedException

ProcessAsync(IPluginOptions)

Inicia el procesamiento de PdfChatGpt con los parámetros especificados.

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

Parámetros

options IPluginOptions: Un objeto de opciones que contiene instrucciones para el PdfChatGpt.

Retorna

Task<ResultContainer>

El objeto de tarea que representa la operación asíncrona.

Excepciones

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptOptions

Información

Representa opciones para el complemento Documentize.PdfChatGpt.

public class PdfChatGptOptions : IPluginOptions

Miembros heredados

Constructores

PdfChatGptOptions()

Inicializa una nueva instancia del objeto Documentize.PdfChatGptOptions.

public PdfChatGptOptions()

Propiedades

Inputs

public List<idatasource> Inputs { get; }

Valor de la Propiedad

Outputs

public List<idatasource> Outputs { get; }

Valor de la Propiedad

Métodos

AddInput(IDataSource)

Agrega una nueva fuente de datos a la colección de datos del complemento PdfChatGpt.

public void AddInput(IDataSource dataSource)

Parámetros

dataSource IDataSource: Fuente de datos (archivo o flujo) a agregar.

AddOutput(IDataSource)

Agrega una nueva fuente de datos para guardar a la colección de datos del complemento PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

Parámetros

saveDataSource IDataSource: Fuente de datos (archivo o flujo) para guardar resultados de operaciones. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptRequestOptions

Información

Representa las opciones para el plugin Documentize.PdfChatGpt.

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Inheritance

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfChatGptRequestOptions()

Inicializa una nueva instancia del objeto Documentize.PdfChatGptRequestOptions con opciones predeterminadas.

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

Inicializa una nueva instancia del objeto Documentize.PdfChatGptRequestOptions con opciones.

public PdfChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)

Parameters

apiKey string: La clave para acceder a la API de ChatGPT.
model string: El nombre del modelo de ChatGPT. El modelo predeterminado es: gpt-3.5-turbo-1106:
apiUrl string: La URL de la API de ChatGPT. La URL predeterminada es: https://api.openai.com/v1/chat/completions.
query string: La solicitud en forma de cadena para ChatGPT.

Properties

ApiKey

Obtiene o establece la clave para acceder a la API de ChatGPT.

public string ApiKey { get; set; }

Property Value

ApiUrl

Obtiene o establece la URL de la API de ChatGPT.

public string ApiUrl { get; set; }

Property Value

CancellationToken

El token de cancelación.

public CancellationToken CancellationToken { get; set; }

Property Value

CancellationToken

MaxTokens

Número máximo de tokens en la respuesta. El valor predeterminado es nulo, lo que significa infinito.

public int? MaxTokens { get; set; }

Property Value

int?

Messages

Obtiene o establece una colección de los objetos Documentize.Message.

public List<message> Messages { get; set; }

Property Value

List<Message>

Remarks

Al agregar múltiples mensajes a las opciones, el orden en la colección de mensajes es el siguiente:

El primer mensaje (si lo hay) es de options.Query, precedido por el mensaje con el contenido: “Eres un asistente útil.”, y el rol es “sistema”.
Luego (si hay) se agregan los mensajes de la colección options.Messages.
Los mensajes de fuentes de archivos (si los hay) se agregan al final, un objeto de mensaje por cada documento con el rol “usuario”. Si no se proporciona ningún mensaje, se lanzará una ArgumentException.

Model

Establece o obtiene el ID del modelo a utilizar.

public string Model { get; set; }

Property Value

NumberOfChoices

Cuántas elecciones de finalización de chat generar para cada mensaje de entrada.

public int NumberOfChoices { get; set; }

Property Value

Query

Obtiene o establece la solicitud en forma de cadena para ChatGPT. Si no está vacío, este es el primer mensaje en la colección, que se enviará en la solicitud.

public string Query { get; set; }

Property Value

Temperature

Qué temperatura de muestreo usar, entre 0 y 2. Valores más altos como 0.8 harán que la salida sea más aleatoria, mientras que valores más bajos como 0.2 la harán más enfocada y determinista. El valor predeterminado es 1.

public double Temperature { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverterOptions

Información

Representa opciones para plugins de conversión a Pdf.

public abstract class PdfConverterOptions : IPluginOptions

Herencia

object ← PdfConverterOptions

Derivados

PdfToXlsOptions

Implementa

IPluginOptions

Miembros heredados

Propiedades

Entradas

Devuelve la colección de datos del plugin PdfConverterOptions.

public List<idatasource> Inputs { get; }

Valor de Propiedad

Salidas

Obtiene la colección de destinos añadidos para guardar los resultados de la operación.

public List<idatasource> Outputs { get; }

Valor de Propiedad

Métodos

AddInput(IDataSource)

Añade una nueva fuente de datos a la colección de datos del plugin PdfConverter.

public void AddInput(IDataSource dataSource)

Parámetros

dataSource IDataSource: Fuente de datos a añadir.

AddOutput(IDataSource)

Añade una nueva fuente de datos a la colección de datos del plugin PdfToXLSXConverterOptions.

public void AddOutput(IDataSource saveDataSource)

Parámetros

saveDataSource IDataSource: Fuente de datos (archivo o flujo) para guardar los resultados de la operación.

Excepciones

NotImplementedException

Namespace: Documentize Assembly: Documentize.dll

Class PdfExtractor

Información

Representa el plugin Documentize.PdfExtractor. Se utiliza para extraer texto, imágenes y datos de formularios de documentos PDF.

public static class PdfExtractor

Herencia

object ← PdfExtractor

Miembros heredados

Ejemplos

El ejemplo demuestra cómo extraer el contenido de texto de un documento PDF.

// Crear un objeto ExtractTextOptions para establecer las instrucciones
var options = new ExtractTextOptions();
// Agregar la ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Realizar el proceso
var results = PdfExtractor.ExtractText(options);
// Obtener el texto extraído del objeto ResultContainer
var textExtracted = results.ResultCollection[0].ToString();

El ejemplo demuestra cómo extraer el contenido de texto de un documento PDF con TextFormattingMode.

// Crear un objeto ExtractTextOptions para establecer TextFormattingMode
var options = new ExtractTextOptions(TextFormattingMode.Pure);
// Agregar la ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Realizar el proceso
var results = PdfExtractor.ExtractText(options);
// Obtener el texto extraído del objeto ResultContainer
var textExtracted = results.ResultCollection[0].ToString();

El ejemplo demuestra cómo extraer imágenes de un documento PDF.

// Crear ExtractImagesOptions para establecer las instrucciones
var options = new ExtractImagesOptions();
// Agregar la ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer la ruta del directorio de salida
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// Realizar el proceso
var results = PdfExtractor.ExtractImages(options);
// Obtener la ruta del resultado de la imagen
var imageExtracted = results.ResultCollection[0].ToFile();

El ejemplo demuestra cómo extraer imágenes de un documento PDF a Streams sin carpeta.

// Crear ExtractImagesOptions para establecer las instrucciones
var options = new ExtractImagesOptions();
// Agregar la ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// No establecer salida - escribirá resultados en streams
// Realizar el proceso
var results = PdfExtractor.ExtractImages(options);
// Obtener Stream
var ms = results.ResultCollection[0].ToStream();
// Copiar datos a un archivo para la demostración
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

El ejemplo demuestra cómo exportar valores de formularios a un archivo CSV.

// Crear un objeto ExtractFormDataToDsvOptions para establecer las instrucciones
var options = new ExtractFormDataToDsvOptions(',', true);
// Agregar la ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer la ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// Realizar el proceso
PdfExtractor.ExtractFormData(options);

Métodos

ExtractFormData(ExtractFormDataToDsvOptions)

Extraer datos de formularios de un documento PDF.

public static ResultContainer ExtractFormData(ExtractFormDataToDsvOptions options)

Parámetros

options ExtractFormDataToDsvOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si no se establecen las opciones.

ExtractImages(ExtractImagesOptions)

Extraer imágenes de un documento PDF.

public static ResultContainer ExtractImages(ExtractImagesOptions options)

Parámetros

options ExtractImagesOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si no se establecen las opciones.

ExtractText(ExtractTextOptions)

Extraer texto de un documento PDF.

public static ResultContainer ExtractText(ExtractTextOptions options)

Parámetros

options ExtractTextOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la extracción.

Excepciones

Si no se establecen las opciones.

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

Información

Representa el plugin Documentize.PdfManager. Utilizado para combinar, dividir, optimizar, rotar, cambiar el tamaño, comprimir documentos PDF y agregar tabla, agregar TOC a documentos PDF. Puede combinar múltiples documentos PDF en un solo PDF. Puede dividir documentos PDF en páginas separadas. Puede optimizar, rotar, cambiar el tamaño, comprimir documentos PDF. Puede rotar, cambiar el tamaño de las páginas del documento PDF. Puede agregar una tabla a un documento PDF. Puede agregar una tabla de contenido a documentos PDF.

public static class PdfManager

Herencia

object ← PdfManager

Miembros heredados

Ejemplos

El ejemplo demuestra cómo combinar dos documentos PDF.

// Crear objeto MergeOptions para establecer instrucciones
var options = new MergeOptions();
// Agregar rutas de archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileDataSource("path_to_your_pdf_file_2.pdf"));
// Establecer ruta de archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
PdfManager.Merge(options);

El ejemplo demuestra cómo dividir un documento PDF.

// Crear objeto SplitOptions para establecer instrucciones
var options = new SplitOptions();
// Agregar ruta de archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer rutas de archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file_2.pdf"));
// Realizar el proceso
PdfManager.Split(options);

El ejemplo demuestra cómo optimizar un documento PDF.

// Crear objeto OptimizeOptions para establecer instrucciones
var options = new OptimizeOptions();
// Agregar ruta de archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta de archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
PdfManager.Optimize(options);

El ejemplo demuestra cómo rotar un documento PDF.

// Crear objeto RotateOptions para establecer instrucciones
var options = new RotateOptions();
// Establecer nueva rotación
options.Rotation = Rotation.On90;
// Agregar ruta de archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta de archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
PdfManager.Rotate(options);

El ejemplo demuestra cómo cambiar el tamaño de un documento PDF.

// Crear objeto ResizeOptions para establecer instrucciones
var options = new ResizeOptions();
// Establecer nuevo tamaño de página
options.PageSize = PageSize.A3;
// Agregar ruta de archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta de archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
PdfManager.Resize(options);

El ejemplo demuestra cómo comprimir un documento PDF.

// Crear objeto CompressOptions para establecer instrucciones
var options = new CompressOptions();
// Agregar ruta de archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta de archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
PdfManager.Compress(options);

El ejemplo demuestra cómo agregar una tabla a un archivo PDF.

// Configurar opciones de tabla
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Nombre")
            .AddCell().AddParagraph("Edad")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Agregar ruta de archivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Establecer ruta de archivo de salida
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Realizar el proceso
PdfManager.AddTable(options);

El ejemplo demuestra cómo agregar una tabla de contenido a un archivo PDF.

// Crear objeto TocOptions para establecer instrucciones
var options = new TocOptions();
// Establecer el título
options.Title = "Mi Tabla de Contenidos";
// Diseñar encabezados
options.Headings.Add(new TocHeading("Introducción", 2));
options.Headings.Add(new TocHeading("Capítulo I", 3));
options.Headings.Add(new TocHeading("Capítulo II", 4));
options.Headings.Add(new TocHeading("Capítulo III", 5));
// Agregar ruta de archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta de archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
PdfManager.AddTableOfContents(options);

El ejemplo demuestra cómo agregar una tabla de contenido a un archivo PDF generando marcadores.

// Crear objeto TocOptions para establecer instrucciones
var options = new TocOptions();
// Establecer el título
options.Title = "Mi Tabla de Contenidos";
// Generar enlaces en marcadores
options.GenerateBookmarks = true;
// Diseñar encabezados
options.Headings.Add(new TocHeading("Introducción", 2, false, 1));
options.Headings.Add(new TocHeading("Capítulo I", 3, true, 1));
options.Headings.Add(new TocHeading("Capítulo II", 4, true, 1));
options.Headings.Add(new TocHeading("Ejemplo A", 4, true, 2));
options.Headings.Add(new TocHeading("Ejemplo B", 4, true, 2));
options.Headings.Add(new TocHeading("Ejemplo C", 4, true, 2));
options.Headings.Add(new TocHeading("Ejemplo D", 4, true, 2));
options.Headings.Add(new TocHeading("Capítulo III", 5, true, 1));
// Agregar ruta de archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta de archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
PdfManager.AddTableOfContents(options);

El ejemplo demuestra cómo agregar una tabla de contenido a un archivo PDF y guardar como flujo.

// Crear objeto TocOptions para establecer instrucciones
var options = new TocOptions();
// Establecer el título
options.Title = "Mi Tabla de Contenidos";
// Diseñar encabezados
options.Headings.Add(new TocHeading("Introducción", 2, false, 1));
// Agregar ruta de archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer flujo de salida 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Realizar el proceso
PdfManager.AddTableOfContents(options);

Métodos

AddTable(TableOptions)

Agregar tabla a documento PDF.

public static ResultContainer AddTable(TableOptions options)

Parámetros

options TableOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

AddTableOfContents(TocOptions)

Agregar tabla de contenido (TOC) a documento PDF.

public static ResultContainer AddTableOfContents(TocOptions options)

Parámetros

options TocOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Compress(CompressOptions)

Comprimir documento PDF. Intenta reducir el tamaño del documento.

public static ResultContainer Compress(CompressOptions options)

Parámetros

options CompressOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Merge(MergeOptions)

Combinar documentos PDF.

public static ResultContainer Merge(MergeOptions options)

Parámetros

options MergeOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Optimize(OptimizeOptions)

Optimizar documento PDF. Linearizar 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 se entregan datos de una página 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 puede realizar incluso antes de que se haya recibido y mostrado toda la página.

public static ResultContainer Optimize(OptimizeOptions options)

Parámetros

options OptimizeOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Resize(ResizeOptions)

Cambiar el tamaño de las páginas del documento PDF.

public static ResultContainer Resize(ResizeOptions options)

Parámetros

options ResizeOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Rotate(RotateOptions)

Rotar páginas del documento PDF.

public static ResultContainer Rotate(RotateOptions options)

Parámetros

options RotateOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Split(SplitOptions)

Dividir documento PDF por páginas.

public static ResultContainer Split(SplitOptions options)

Parámetros

options SplitOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

PdfToHtmlOptions.SaveDataType

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToDocOptions

Información

Representa las opciones del conversor de PDF a DOC para el plugin Documentize.DocConverter.

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← PdfToDocOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

PdfToDocOptions()

Inicializa una nueva instancia del objeto Documentize.PdfToDocOptions con opciones predeterminadas.

public PdfToDocOptions()

Propiedades

Mode

Permite controlar cómo se convierte un documento PDF en un documento de procesamiento de texto.

public DocConversionMode Mode { get; set; }

Valor de la propiedad

DocConversionMode

Comentarios

Utiliza el modo Documentize.DocConversionMode.TextBox cuando el documento resultante no va a ser editado mucho más. Los cuadros de texto son fáciles de modificar cuando no hay mucho que hacer.

Utiliza el modo Documentize.DocConversionMode.Flow cuando el documento de salida necesita más edición. Los párrafos y líneas de texto en el modo de flujo permiten una fácil modificación del texto, pero los objetos de formateo no soportados se verán peor que en el modo Documentize.DocConversionMode.TextBox.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToHtmlOptions

Información

Representa las opciones del conversor de PDF a HTML para el plugin Documentize.HtmlConverter.

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← PdfToHtmlOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

PdfToHtmlOptions(SaveDataType)

Inicializa una nueva instancia del objeto Documentize.PdfToHtmlOptions para el tipo de dato de salida especificado.

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType = SaveDataType.FileWithExternalResources)

Parámetros

outputDataType PdfToHtmlOptions.SaveDataType: Tipo de dato de salida.

Propiedades

OutputDataType

Obtiene el tipo de dato de salida.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class PdfToJpegOptions

Información

Representa las opciones del convertidor de PDF a JPEG para el plugin Documentize.JpegConverter.

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← PdfToJpegOptions

Implementa

IPluginOptions

Miembros Heredados

Constructores

PdfToJpegOptions()

Inicializa una nueva instancia del objeto Documentize.PdfToJpegOptions.

public PdfToJpegOptions()

Propiedades

OutputResolution

Obtiene o establece el valor de resolución de las imágenes resultantes.

public int OutputResolution { get; set; }

Valor de Propiedad

PageList

Obtiene o establece una lista de páginas para el proceso.

public List<int> PageList { get; set; }

Valor de Propiedad

List<int>

Quality

Obtiene y establece la calidad de salida. Especifica el nivel de compresión para una imagen. El rango de valores útiles para la calidad es de 0 a 100. Cuanto más bajo sea el número especificado, mayor será la compresión y, por lo tanto, menor será la calidad de la imagen. Cero te daría la imagen de menor calidad y 100 la de mayor calidad.

public int Quality { get; set; }

Valor de Propiedad

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPngOptions

Información

Representa las opciones del convertidor de PDF a PNG para el complemento Documentize.PngConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← PdfToPngOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

PdfToPngOptions()

Inicializa una nueva instancia del objeto Documentize.PdfToPngOptions.

public PdfToPngOptions()

Propiedades

OutputResolution

Obtiene o establece el valor de resolución de las imágenes resultantes.

public int OutputResolution { get; set; }

Valor de la propiedad

PageList

Obtiene o establece una lista de páginas para el proceso.

public List<int> PageList { get; set; }

Valor de la propiedad

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToTiffOptions

Información

Representa las opciones del convertidor de PDF a TIFF para el complemento Documentize.TiffConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToTiffOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToTiffOptions()

Inicializa una nueva instancia del objeto Documentize.PdfToTiffOptions.

public PdfToTiffOptions()

Properties

ColorDepth

Obtiene o establece la profundidad de color.

public TiffColorDepth ColorDepth { get; set; }

Property Value

TiffColorDepth

Remarks

El valor predeterminado es Documentize.TiffColorDepth.Format32bpp.

Compression

Obtiene o establece el tipo de compresión.

public TiffCompression Compression { get; set; }

Property Value

TiffCompression

Remarks

El valor predeterminado es Documentize.TiffCompression.LZW.

MultiPage

Obtiene y establece un indicador que permite guardar todas las páginas en un TIFF multipágina. El valor predeterminado es false.

public bool MultiPage { get; set; }

Property Value

OutputResolution

Obtiene o establece el valor de resolución de las imágenes resultantes.

public int OutputResolution { get; set; }

Property Value

PdfToXlsOptions.ExcelFormat

PageList

Obtiene o establece una lista de páginas para el proceso.

public List<int> PageList { get; set; }

Property Value

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToXlsOptions

Información

Representa las opciones del convertidor de PDF a XLS/XLSX para el plugin Documentize.XlsConverter.

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

Herencia

object ← PdfConverterOptions ← PdfToXlsOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

PdfToXlsOptions()

Inicializa una nueva instancia del objeto Documentize.PdfToXlsOptions con opciones predeterminadas.

public PdfToXlsOptions()

Propiedades

Formato

Formato de salida.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Valor de propiedad

InsertarColumnaEnBlancoAlPrincipio

Establecer en verdadero si necesitas insertar una columna en blanco como la primera columna de la hoja de cálculo. El valor predeterminado es falso; significa que no se insertará la columna en blanco.

public bool InsertBlankColumnAtFirst { get; set; }

Valor de propiedad

MinimizarElNúmeroDeHojasDeCálculo

Establecer en verdadero si necesitas minimizar el número de hojas de cálculo en el libro resultante. El valor predeterminado es falso; significa que cada página PDF se guarda como una hoja de cálculo separada.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Valor de propiedad

Namespace: Documentize Assembly: Documentize.dll

Class PluginBaseOptions

Información

Representa las opciones base para los plugins.

public class PluginBaseOptions : IPluginOptions

Herencia

object ← PluginBaseOptions

Derivados

Implementa

IPluginOptions

Miembros heredados

Propiedades

CloseInputStreams

Cierra los flujos de entrada después de que se complete la operación.

public bool CloseInputStreams { get; set; }

Valor de la propiedad

CloseOutputStreams

Cierra los flujos de salida después de que se complete la operación.

public bool CloseOutputStreams { get; set; }

Valor de la propiedad

Inputs

Devuelve los datos de Inputs para la operación.

public List<idatasource> Inputs { get; }

Valor de la propiedad

Outputs

Devuelve los datos de Outputs para la operación.

public List<idatasource> Outputs { get; }

Valor de la propiedad

Métodos

AddInput(IDataSource)

Agrega nuevos Datos a Inputs.

public void AddInput(IDataSource dataSource)

Parámetros

dataSource IDataSource: Datos a agregar.

AddOutput(IDataSource)

Agrega nuevos Datos a Outputs.

public void AddOutput(IDataSource saveDataSource)

Parámetros

saveDataSource IDataSource: Datos a agregar. :

Namespace: Documentize Assembly: Documentize.dll

Class PngConverter

Información

Representa el plugin Documentize.PngConverter. Se utiliza para convertir documentos PDF en formato PNG.

public static class PngConverter

Herencia

object ← PngConverter

Miembros heredados

Ejemplos

El ejemplo demuestra cómo convertir un documento PDF en formato PNG.

// Crear objeto PdfToPngOptions para establecer instrucciones
var options = new PdfToPngOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Establecer ruta del directorio de salida
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Realizar el proceso
PngConverter.Process(options);

El ejemplo demuestra cómo convertir 1 página de un documento PDF en formato PNG.

// Crear objeto PdfToPngOptions para establecer instrucciones
var options = new PdfToPngOptions()
// Procesar solo la primera página
options.PageList = [1];
// Establecer la resolución de salida a 200 DPI
options.OutputResolution = 200;
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Establecer ruta del directorio de salida
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Realizar el proceso
PngConverter.Process(options);

El ejemplo demuestra cómo convertir un documento PDF en formato PNG a flujos.

// Crear objeto PdfToJpegOptions para establecer instrucciones
var options = new PdfToPngOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Realizar el proceso
var results = PngConverter.Process(options);
// Obtener resultados de flujos
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Métodos

Process(PdfToPngOptions)

Convierte un documento PDF en formato PNG.

public static ResultContainer Process(PdfToPngOptions options)

Parámetros

options PdfToPngOptions: Un objeto de opciones que contiene instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si no se establecen opciones.

Namespace: Documentize Assembly: Documentize.dll

Class ResizeOptions

Información

Representa las opciones de redimensionamiento para el plugin Documentize.PdfManager.

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← ResizeOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

ResizeOptions()

Inicializa una nueva instancia del objeto Documentize.ResizeOptions con opciones predeterminadas.

public ResizeOptions()

Propiedades

PageSize

Obtiene o establece un nuevo tamaño de página.

public PageSize PageSize { get; set; }

Valor de la propiedad

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class ResultContainer

Información

Representa un contenedor que contiene la colección de resultados del procesamiento del plugin.

public class ResultContainer

Herencia

object ← ResultContainer

Miembros heredados

Propiedades

ResultCollection

Obtiene la colección de resultados de la operación

public List<ioperationresult> ResultCollection { get; }

Valor de la propiedad

List<IOperationResult>

Namespace: Documentize Assembly: Documentize.dll

Class RotateOptions

Información

Representa las opciones de rotación para el plugin Documentize.PdfManager.

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← RotateOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

RotateOptions()

Inicializa una nueva instancia del objeto Documentize.RotateOptions con opciones predeterminadas.

public RotateOptions()

Propiedades

Rotation

Obtiene o establece la rotación de nuevas páginas.

public Rotation Rotation { get; set; }

Valor de la propiedad

Rotation

Namespace: Documentize Assembly: Documentize.dll

Class Security

Información

Representa el plugin Documentize.Security. Se utiliza para cifrar y descifrar documentos PDF.

public static class Security

Herencia

object ← Security

Miembros heredados

Ejemplos

El ejemplo demuestra cómo cifrar un documento PDF.

// Crear objeto EncryptionOptions para establecer instrucciones
var options = new EncryptionOptions("123456", "qwerty");
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
Security.Process(options);

El ejemplo demuestra cómo descifrar un documento PDF.

// Crear objeto DecryptionOptions para establecer instrucciones
var options = new DecryptionOptions("123456");
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
Security.Process(options);

Métodos

Process(EncryptionOptions)

Cifrar documento PDF.

public static ResultContainer Process(EncryptionOptions options)

Parámetros

options EncryptionOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Process(DecryptionOptions)

Descifrar documento PDF.

public static ResultContainer Process(DecryptionOptions options)

Parámetros

options DecryptionOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class Signature

Información

Representa el plugin Documentize.Signature. Utilizado para firmar documentos PDF.

public static class Signature

Herencia

object ← Signature

Miembros heredados

Ejemplos

El ejemplo demuestra cómo firmar un documento PDF.

// Crear objeto SignOptions para establecer instrucciones
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
Signature.Process(options);

El ejemplo demuestra cómo firmar un documento PDF con un Stream del archivo PFX.

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
Signature.Process(options);

El ejemplo demuestra cómo firmar un documento PDF con una firma invisible.

var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Configurar firma invisible
signOptions.Visible = false;
// Realizar el proceso
Signature.Process(options);

El ejemplo demuestra cómo firmar un documento PDF con opciones adicionales.

// Crear objeto SignOptions para establecer instrucciones
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Parámetros opcionales
options.Reason = "mi razón";
options.Contact = "mi contacto";
options.Location = "mi ubicación";
options.PageNumber = 3;
// Realizar el proceso
Signature.Process(options);

Métodos

Process(SignOptions)

Firmar documento PDF.

public static ResultContainer Process(SignOptions options)

Parámetros

options SignOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class SignOptions

Información

Representa las opciones de firma para el plugin Documentize.Signature.

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← SignOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

SignOptions(string, string)

Inicializa una nueva instancia del objeto Documentize.SignOptions con opciones predeterminadas.

public SignOptions(string pfx, string password)

Parámetros

pfx string: La ruta al archivo pfx.
password string: La contraseña para el archivo pfx.

SignOptions(Stream, string)

Inicializa una nueva instancia del objeto Documentize.SignOptions con opciones predeterminadas.

public SignOptions(Stream pfx, string password)

Parámetros

pfx Stream: El stream con el archivo pfx.
password string: La contraseña para el archivo pfx.

Propiedades

Contact

El contacto de la firma.

public string Contact { get; set; }

Valor de la Propiedad

Location

La ubicación de la firma.

public string Location { get; set; }

Valor de la Propiedad

Name

El nombre del campo de firma existente. Nulo para crear un nuevo campo.

public string Name { get; set; }

Valor de la Propiedad

PageNumber

El número de página en el que se realiza la firma.

public int PageNumber { get; set; }

Valor de la Propiedad

Reason

La razón de la firma.

public string Reason { get; set; }

Valor de la Propiedad

Rectangle

El rectángulo de la firma.

public Rectangle Rectangle { get; set; }

Valor de la Propiedad

Rectangle

Visible

La visibilidad de la firma.

public bool Visible { get; set; }

Valor de la Propiedad

Namespace: Documentize Assembly: Documentize.dll

Class SplitOptions

Información

Representa opciones de división para el complemento Documentize.PdfManager.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← SplitOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

SplitOptions()

Inicializa una nueva instancia del objeto Documentize.SplitOptions con opciones predeterminadas.

public SplitOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Splitter

Información

Representa el plugin Documentize.Splitter. Se utiliza para dividir documentos PDF en páginas separadas.

[Obsolete("Por favor, utiliza la clase PdfManager. La clase será eliminada pronto.")]
public static class Splitter

Herencia

object ← Splitter

Miembros heredados

Métodos

Process(SplitOptions)

Divide el documento PDF por páginas.

public static ResultContainer Process(SplitOptions options)

Parámetros

options SplitOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class StreamDataSource

Información

Representa la fuente de datos de flujo para operaciones de carga y guardado de un plugin.

public sealed class StreamDataSource : IDataSource

Herencia

object ← StreamDataSource

Implementa

IDataSource

Miembros heredados

Constructores

StreamDataSource(Stream)

Inicializa una nueva fuente de datos de flujo con el objeto de flujo especificado.

public StreamDataSource(Stream data)

Parámetros

data Stream: Objeto de flujo

Propiedades

Data

Obtiene el objeto de flujo de la fuente de datos actual.

public Stream Data { get; }

Valor de la propiedad

Stream

DataType

Tipo de fuente de datos (flujo).

public DataType DataType { get; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class StreamResult

Información

Representa el resultado de una operación en forma de Stream.

public sealed class StreamResult : IOperationResult

Herencia

object ← StreamResult

Implementa

IOperationResult

Miembros heredados

Propiedades

Data

Obtiene datos en bruto.

public object Data { get; }

Valor de la propiedad

IsFile

Indica si el resultado es una ruta a un archivo de salida.

public bool IsFile { get; }

Valor de la propiedad

IsStream

Indica si el resultado es un objeto de tipo stream.

public bool IsStream { get; }

Valor de la propiedad

IsString

Indica si el resultado es una cadena.

public bool IsString { get; }

Valor de la propiedad

Métodos

ToFile()

Intenta convertir el resultado a un archivo.

public string ToFile()

Retorna

string : Una cadena que representa la ruta al archivo de salida si el resultado es un archivo; de lo contrario null.

ToStream()

Intenta convertir el resultado a un objeto stream.

public Stream ToStream()

Retorna

Stream : Un objeto stream que representa los datos de salida si el resultado es un stream; de lo contrario null.

Namespace: Documentize Assembly: Documentize.dll

Class StringResult

Información

Representa el resultado de la operación en forma de cadena.

public sealed class StringResult : IOperationResult

Herencia

object ← StringResult

Implementa

IOperationResult

Miembros heredados

Propiedades

Data

Obtiene los datos sin procesar.

public object Data { get; }

Valor de la propiedad

IsFile

Indica si el resultado es una ruta a un archivo de salida.

public bool IsFile { get; }

Valor de la propiedad

IsStream

Indica si el resultado es un objeto de flujo.

public bool IsStream { get; }

Valor de la propiedad

IsString

Indica si el resultado es una cadena.

public bool IsString { get; }

Valor de la propiedad

Text

Devuelve la representación en cadena del resultado.

public string Text { get; }

Valor de la propiedad

Métodos

ToFile()

Intenta convertir el resultado en un archivo.

public string ToFile()

Devuelve

string : Una cadena que representa la ruta al archivo de salida si el resultado es un archivo; de lo contrario, null.

ToStream()

Intenta convertir el resultado en un objeto de flujo.

public Stream ToStream()

Devuelve

Stream : Un objeto de flujo que representa los datos de salida si el resultado es un flujo; de lo contrario, null.

ToString()

Intenta convertir el resultado en una cadena.

public override string ToString()

Devuelve

string : Una cadena que representa el contenido de texto si el resultado es una cadena; de lo contrario, devuelve base.ToString().

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

Información

Clase que representa un constructor para tablas en la página pdf.

public class TableBuilder

Herencia

object ← TableBuilder

Derivados

TableRowBuilder

Miembros heredados

Métodos

AddRow()

Añadir nueva fila a la tabla.

public virtual TableRowBuilder AddRow()

Devuelve

TableRowBuilder : Instancia del actual Documentize.TableRowBuilder.

AddTable()

Añadir nueva tabla al documento.

public TableBuilder AddTable()

Devuelve

TableBuilder : Instancia del actual Documentize.TableBuilder.

InsertPageAfter(int)

Insertar página después de la página especificada.

public TableOptions InsertPageAfter(int page)

Parámetros

page int: Número de página después de la cual insertar la tabla.

Devuelve

TableOptions : Instancia del actual Documentize.TableOptions.

InsertPageBefore(int)

Insertar página antes de la página especificada.

public TableOptions InsertPageBefore(int page)

Parámetros

page int: Número de página antes de la cual insertar la tabla.

Devuelve

TableOptions : Instancia del actual Documentize.TableOptions.

Operadores

implicit operator TableOptions(TableBuilder)

Convierte el constructor Documentize.TableBuilder a opciones Documentize.TableOptions

public static implicit operator TableOptions(TableBuilder builder)

Parámetros

builder TableBuilder: Instancia del actual Documentize.TableBuilder.

Devuelve

TableOptions : Resultado de la conversión a PdfGeneratorTableOptions.

Namespace: Documentize Assembly: Documentize.dll

Class TableCellBuilder

Información

Clase que representa un constructor para celdas de tabla.

public class TableCellBuilder : TableRowBuilder

Herencia

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

Miembros heredados

Métodos

AddCell()

Agregar celda a la tabla.

public override TableCellBuilder AddCell()

Devuelve

TableCellBuilder : Instancia del actual Documentize.TableCellBuilder.

AddParagraph(params string[])

Agregar párrafos a la celda de la tabla.

public TableCellBuilder AddParagraph(params string[] paragraphs)

Parámetros

paragraphs string[]: Texto para los párrafos.

Devuelve

TableCellBuilder : Instancia del actual Documentize.TableCellBuilder.

Namespace: Documentize Assembly: Documentize.dll

Class TableGenerator

Información

Representa el plugin Documentize.TableGenerator. Se utiliza para agregar una tabla a un documento PDF.

[Obsolete("Por favor, use la clase PdfManager. La clase será eliminada pronto.")]
public static class TableGenerator

Herencia

object ← TableGenerator

Miembros heredados

Ejemplos

El ejemplo demuestra cómo agregar una tabla a un archivo PDF.

// Configurar opciones de la tabla
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Nombre")
            .AddCell().AddParagraph("Edad")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("ruta_a_input.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("ruta_a_output.pdf"));
// Realizar el proceso
TableGenerator.Process(options);

Métodos

Process(TableOptions)

Agregar tabla al documento PDF.

public static ResultContainer Process(TableOptions options)

Parámetros

options TableOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class TableOptions

Información

Representa opciones para agregar una tabla al documento mediante el complemento Documentize.PdfManager.

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← TableOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

TableOptions()

Inicializa una nueva instancia del objeto Documentize.TableOptions con opciones predeterminadas.

public TableOptions()

Métodos

AddTable()

Agregar una tabla al documento.

public TableBuilder AddTable()

Retorna

TableBuilder : Nueva instancia de Documentize.TableBuilder.

Create()

Crear una instancia de Documentize.TableOptions.

public static TableOptions Create()

Retorna

TableOptions : Nueva instancia de Documentize.TableOptions.

InsertPageAfter(int)

Insertar página después de la página especificada.

public TableOptions InsertPageAfter(int page)

Parámetros

page int: Número de página después de la cual insertar la tabla.

Retorna

TableOptions : Instancia de Documentize.TableOptions actual.

InsertPageBefore(int)

Insertar página antes de la página especificada.

public TableOptions InsertPageBefore(int page)

Parámetros

page int: Número de página antes de la cual insertar la tabla.

Retorna

TableOptions : Instancia de Documentize.TableOptions actual.

Namespace: Documentize Assembly: Documentize.dll

Class TableRowBuilder

Información

Clase representa constructor para fila de tabla.

public class TableRowBuilder : TableBuilder

Herencia

object ← TableBuilder ← TableRowBuilder

Derivados

TableCellBuilder

Miembros heredados

Métodos

AddCell()

Agregar celda a la fila de tabla.

public virtual TableCellBuilder AddCell()

Devuelve

TableCellBuilder : Instancia del Documentize.TableCellBuilder creado.

AddRow()

Sobrescribiendo AddRow.

public override TableRowBuilder AddRow()

Devuelve

TableRowBuilder : Instancia de Documentize.TableRowBuilder actual.

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractor

Información

Representa el plugin Documentize.TextExtractor. Se utiliza para extraer texto de documentos PDF.

[Obsolete("Por favor, utiliza la clase PdfExtractor. La clase será eliminada pronto.")]
public static class TextExtractor

Herencia

object ← TextExtractor

Miembros heredados

Métodos

Process(ExtractTextOptions)

Extrae texto de un documento PDF.

public static ResultContainer Process(ExtractTextOptions options)

Parámetros

options ExtractTextOptions: Un objeto de opciones que contiene instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la extracción.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractorOptions

Información

Representa las opciones de extracción de texto para el complemento Documentize.TextExtractor.

public sealed class TextExtractorOptions

Herencia

object ← TextExtractorOptions

Miembros heredados

Constructores

TextExtractorOptions(TextFormattingMode)

Inicializa una nueva instancia del objeto Documentize.TextExtractorOptions para el modo de formateo de texto especificado.

public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parámetros

formattingMode TextFormattingMode: Valor del modo de formateo de texto.

Propiedades

FormattingMode

Obtiene el modo de formateo.

public TextFormattingMode FormattingMode { get; set; }

Valor de la propiedad

TextFormattingMode

Inputs

Devuelve datos de Inputs para la operación.

public List<idatasource> Inputs { get; }

Valor de la propiedad

Métodos

AddInput(IDataSource)

Agrega nuevos datos a Inputs.

public void AddInput(IDataSource dataSource)

Parámetros

dataSource IDataSource: Fuente de datos a agregar. :

Namespace: Documentize Assembly: Documentize.dll

Class TiffConverter

Información

Representa el plugin Documentize.TiffConverter. Se utiliza para convertir documentos PDF a formato TIFF.

public static class TiffConverter

Herencia

object ← TiffConverter

Miembros heredados

Ejemplos

El ejemplo demuestra cómo convertir un documento PDF a formato TIFF.

// Crear objeto PdfToTiffOptions para establecer instrucciones
var options = new PdfToTiffOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del directorio de salida
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Realizar el proceso
TiffConverter.Process(options);

El ejemplo demuestra cómo convertir un documento PDF a formato TIFF personalizando las páginas y la resolución (DPI).

// Crear objeto PdfToTiffOptions para establecer instrucciones
var options = new PdfToTiffOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del directorio de salida
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Establecer páginas
options.PageList = [1, 3];
// Establecer la resolución de la imagen resultante
options.OutputResolution = 400;
// Realizar el proceso
TiffConverter.Process(options);

El ejemplo demuestra cómo convertir un documento PDF a TIFF como Multi-Página.

// Crear objeto PdfToTiffOptions para establecer instrucciones
var options = new PdfToTiffOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del directorio de salida
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Habilitar salida TIFF Multi-Página
options.MultiPage = true;
// Realizar el proceso
TiffConverter.Process(options);

El ejemplo demuestra cómo convertir un documento PDF a formato TIFF personalizando la compresión y la profundidad de color.

// Crear objeto PdfToTiffOptions para establecer instrucciones
var options = new PdfToTiffOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del directorio de salida
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Establecer compresión y profundidad de color
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// Realizar el proceso
TiffConverter.Process(options);

El ejemplo demuestra cómo convertir un documento PDF a formato TIFF a flujos.

// Crear objeto PdfToTiffOptions para establecer instrucciones
var options = new PdfToTiffOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Realizar el proceso
var results = TiffConverter.Process(options);
// Obtener resultados de flujo
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Métodos

Process(PdfToTiffOptions)

Convierte un documento PDF a formato TIFF.

public static ResultContainer Process(PdfToTiffOptions options)

Parámetros

options PdfToTiffOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Class Timestamp

Información

Representa el plugin Documentize.Timestamp. Se utiliza para agregar una marca de tiempo a un documento.

public static class Timestamp

Herencia

object ← Timestamp

Miembros heredados

Ejemplos

El ejemplo demuestra cómo agregar una marca de tiempo al documento.

// Crear objeto AddTimestampOptions para establecer instrucciones
var options = new AddTimestampOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file", "timestamp_server_url");
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar el proceso
Timestamp.Process(options);

Métodos

Process(AddTimestampOptions)

Inicia el procesamiento de Documentize.Timestamp con los parámetros especificados.

public static ResultContainer Process(AddTimestampOptions options)

Parámetros

options AddTimestampOptions: Un objeto de opciones que contiene instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Namespace: Documentize Assembly: Documentize.dll

Class TocGenerator

Información

Representa el complemento Documentize.TocGenerator. Se utiliza para agregar una Tabla de Contenidos a documentos PDF.

[Obsolete("Por favor, usa la clase PdfManager. La clase será eliminada pronto.")]
public static class TocGenerator

Herencia

object ← TocGenerator

Miembros heredados

Ejemplos

El ejemplo demuestra cómo agregar una Tabla de Contenidos a un archivo PDF.

// Crear objeto TocOptions para establecer instrucciones
var options = new TocOptions();
// Establecer el Título
options.Title = "Mi Tabla de Contenidos";
// Diseñar Encabezados
options.Headings.Add(new TocHeading("Introducción", 2));
options.Headings.Add(new TocHeading("Capítulo I", 3));
options.Headings.Add(new TocHeading("Capítulo II", 4));
options.Headings.Add(new TocHeading("Capítulo III", 5));
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("ruta_a_tu_archivo_pdf.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("ruta_a_archivo_pdf_resultante.pdf"));
// Realizar el proceso
TocGenerator.Process(options);

El ejemplo demuestra cómo agregar una Tabla de Contenidos a un archivo PDF generando marcadores.

// Crear objeto TocOptions para establecer instrucciones
var options = new TocOptions();
// Establecer el Título
options.Title = "Mi Tabla de Contenidos";
// Generar enlaces en marcadores
options.GenerateBookmarks = true;
// Diseñar Encabezados
options.Headings.Add(new TocHeading("Introducción", 2, false, 1));
options.Headings.Add(new TocHeading("Capítulo I", 3, true, 1));
options.Headings.Add(new TocHeading("Capítulo II", 4, true, 1));
options.Headings.Add(new TocHeading("Ejemplo A", 4, true, 2));
options.Headings.Add(new TocHeading("Ejemplo B", 4, true, 2));
options.Headings.Add(new TocHeading("Ejemplo C", 4, true, 2));
options.Headings.Add(new TocHeading("Ejemplo D", 4, true, 2));
options.Headings.Add(new TocHeading("Capítulo III", 5, true, 1));
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("ruta_a_tu_archivo_pdf.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("ruta_a_archivo_pdf_resultante.pdf"));
// Realizar el proceso
TocGenerator.Process(options);

El ejemplo demuestra cómo agregar una Tabla de Contenidos a un archivo PDF y guardarlo como un flujo.

// Crear objeto TocOptions para establecer instrucciones
var options = new TocOptions();
// Establecer el Título
options.Title = "Mi Tabla de Contenidos";
// Diseñar Encabezados
options.Headings.Add(new TocHeading("Introducción", 2, false, 1));
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("ruta_a_tu_archivo_pdf.pdf"));
// Establecer flujo de salida 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Realizar el proceso
TocGenerator.Process(options);

Métodos

Process(TocOptions)

Inicia el procesamiento de Documentize.TocGenerator con los parámetros especificados.

public static ResultContainer Process(TocOptions options)

Parámetros

options TocOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto Documentize.ResultContainer que contiene el resultado de la operación.

Namespace: Documentize Assembly: Documentize.dll

Class TocHeading

Información

Representa las opciones para encabezados o títulos de la tabla de contenido que deben ser documentados por el complemento Documentize.PdfManager.

public class TocHeading

Herencia

object ← TocHeading

Miembros heredados

Constructores

TocHeading(string, int, bool, int)

Inicializa una nueva instancia de Documentize.TocHeading.

public TocHeading(string text = "", int pageNumber = 1, bool generateNumbering = false, int level = 1)

Parámetros

text string: El Texto del Encabezado.
pageNumber int: Número de página para el enlace.
generateNumbering bool: Generación de números.
level int: El Nivel.

Propiedades

GenerateNumbering

Generación de números. Si true, entonces la numeración debe hacerse automáticamente; de lo contrario, la numeración debe hacerse manualmente.

public bool GenerateNumbering { get; set; }

Valor de la propiedad

Level

El Nivel. Utilizado para la generación de números.

public int Level { get; set; }

Valor de la propiedad

PageNumber

El Número de página para el enlace.

public int PageNumber { get; set; }

Valor de la propiedad

Text

El Texto del Título.

public string Text { get; set; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class TocOptions

Información

Representa las opciones para agregar una Tabla de Contenidos al documento mediante el plugin Documentize.PdfManager.

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← TocOptions

Implements

IPluginOptions

Inherited Members

Constructors

TocOptions()

Inicializa una nueva instancia del objeto Documentize.TocOptions con opciones por defecto.

public TocOptions()

Properties

GenerateBookmarks

Uso de la generación de marcadores. Si se establece en true, los marcadores se borrarán y generarán por encabezados; de lo contrario, los marcadores no cambiarán.

public bool GenerateBookmarks { get; set; }

Property Value

Headings

Encabezados o Títulos de la Tabla de Contenidos.

public List<tocheading> Headings { get; set; }

Property Value

List<TocHeading>

Title

El Título de la Tabla de Contenidos.

public string Title { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class XlsConverter

Información

Representa el plugin Documentize.XlsConverter. Se utiliza para convertir documentos PDF a formatos XLSX/XLS/CSV/XLSM/ODS.

public static class XlsConverter

Herencia

object ← XlsConverter

Miembros heredados

Ejemplos

El ejemplo demuestra cómo convertir un PDF a un documento XLSX.

// Crear objeto PdfToXlsOptions para establecer instrucciones
var options = new PdfToXlsOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xlsx"));
// Realizar el proceso
XlsConverter.Process(options);

El ejemplo demuestra cómo convertir un PDF a un documento XLS.

// Crear objeto PdfToXlsOptions para establecer instrucciones
var options = new PdfToXlsOptions();
// Agregar ruta del archivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Especificar formato XLS
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// Establecer ruta del archivo de salida
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xls"));
// Realizar el proceso
XlsConverter.Process(options);

Métodos

Process(PdfToXlsOptions)

Convierte un documento PDF a formatos XLSX/XLS/CSV/XLSM/ODS.

public static ResultContainer Process(PdfToXlsOptions options)

Parámetros

options PdfToXlsOptions: Un objeto de opciones que contiene instrucciones para la operación.

Retorna

ResultContainer : Un objeto que contiene el resultado de la operación.

Excepciones

Si las opciones no están configuradas.

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertErrorAction

Información

Esta clase representa la acción para errores de conversión.

public enum ConvertErrorAction

Campos

Delete = 0
None = 1

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertSoftMaskAction

Información

Esta acción representa acciones para la conversión de imágenes con máscara suave.

public enum ConvertSoftMaskAction

Campos

ConvertToStencilMask = 1: La máscara suave se convertirá en una máscara de plantilla.
Default = 0: Utilizar la estrategia predeterminada.

Namespace: Documentize Assembly: Documentize.dll

Enum DataType

Información

Representa los posibles tipos de datos para el procesamiento de complementos.

public enum DataType

Campos

Directory = 2: El tipo de dato es un directorio representado por la ruta a él.
File = 0: El tipo de dato es un archivo representado por la ruta a él.
Stream = 1: El tipo de dato es un flujo.

Namespace: Documentize Assembly: Documentize.dll

Enum DocConversionMode

Información

Define el modo de conversión del documento de salida.

public enum DocConversionMode

Campos

Flow = 1: Modo de reconocimiento completo, el motor realiza agrupamientos y análisis de múltiples niveles para restaurar la intención original del autor del documento y producir un documento lo más editable posible. El inconveniente es que el documento de salida podría verse diferente del archivo PDF original.
TextBox = 0: Este modo es rápido y bueno para preservar al máximo la apariencia original del archivo PDF, pero la editabilidad del documento resultante podría estar limitada. Cada bloque de texto visualmente agrupado en el archivo PDF original se convierte en un cuadro de texto en el documento resultante. Esto logra una máxima semejanza del documento de salida con el archivo PDF original. El documento de salida se verá bien, pero consistirá únicamente en cuadros de texto y podría hacer que la edición posterior del documento en Microsoft Word sea bastante difícil. Este es el modo predeterminado.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlMediaType

Información

Especifica los tipos de medios posibles utilizados durante la representación.

public enum HtmlMediaType

Campos

Print = 0: Imprimir.
Screen = 1: Pantalla.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlPageLayoutOption

Información

Especifica banderas que junto con otras opciones determinan tamaños y diseños de páginas.

public enum HtmlPageLayoutOption

Campos

FitToWidestContentWidth = 3: Indica que el ancho de la página se determina a partir del tamaño del contenido en sí, no del ancho de página especificado.
None = 0: Valor predeterminado que indica que el HtmlPageLayoutOption no afectará los tamaños y diseños de las páginas.
ScaleToPageWidth = 256: Indica que el contenido del documento se escalará para ajustarse a la página.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfAStandardVersion

Información

Especifica la versión del estándar PDF/A para un documento PDF.

public enum PdfAStandardVersion

Fields

Auto = 0: La versión del estándar PDF/A se determina automáticamente.
PDF_A_1A = 1: Especifica la versión del estándar PDF/A-1a.
PDF_A_1B = 2: Especifica la versión del estándar PDF/A-1b.
PDF_A_2A = 3: Especifica la versión del estándar PDF/A-2a.
PDF_A_2B = 4: Especifica la versión del estándar PDF/A-2b.
PDF_A_2U = 5: Especifica la versión del estándar PDF/A-2u.
PDF_A_3A = 6: Especifica la versión del estándar PDF/A-3a.
PDF_A_3B = 7: Especifica la versión del estándar PDF/A-3b.
PDF_A_3U = 8: Especifica la versión del estándar PDF/A-3u.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfToHtmlOptions.SaveDataType

Información

Define el tipo de salida del archivo HTML.

public enum PdfToHtmlOptions.SaveDataType

Campos

FileWithEmbeddedResources = 1: Guardar HTML en un archivo con recursos incorporados
FileWithExternalResources = 0: Guardar HTML en un archivo con recursos externos
StreamWithEmbeddedResources = 2: Guardar HTML en un flujo de archivo con recursos incorporados

Namespace: Documentize Assembly: Documentize.dll

Enum PdfToXlsOptions.ExcelFormat

Información

Permite especificar el formato de archivo xls/xlsx/xml/csv. El valor por defecto es XLSX.

public enum PdfToXlsOptions.ExcelFormat

Campos

CSV = 2: Un formato de archivo de valores separados por comas (.csv).
ODS = 4: Hoja de cálculo de documento abierto.
XLSM = 3: Un formato de archivo de Office Open XML habilitado para macros (.xlsm).
XLSX = 1: Formato de archivo Office Open XML (.xlsx).
XMLSpreadSheet2003 = 0: Formato de archivo Excel 2003 XML (.xls).

Namespace: Documentize Assembly: Documentize.dll

Enum Role

Información

El rol del autor de los mensajes.

public enum Role

Campos

Assistant = 2
System = 1
User = 0

Namespace: Documentize Assembly: Documentize.dll

Enum Rotation

Información

Enumeración de los valores de rotación posibles.

public enum Rotation

Fields

None = 0: No rotado.
On180 = 2: Rotado 180 grados.
On270 = 3: Rotado 270 grados en el sentido de las agujas del reloj.
On360 = 4: Rotado 360 grados en el sentido de las agujas del reloj.
On90 = 1: Rotado 90 grados en el sentido de las agujas del reloj.

Namespace: Documentize Assembly: Documentize.dll

Enum TextExtractorOptions.TextFormattingMode

Información

Define diferentes modos que se pueden usar al convertir un documento PDF en texto. Consulta la clase Documentize.TextExtractorOptions.

public enum TextExtractorOptions.TextFormattingMode

Fields

Plain = 2: Representa el contenido de texto del PDF teniendo en cuenta la posición relativa de los fragmentos de texto pero sin añadir espacios extra.
Pure = 0: Representa el contenido de texto del PDF con algunas rutinas de formato. Esto incluye tener en cuenta las posiciones relativas y añadir espacios extra para alinear el texto con el ancho de la página.
Raw = 1: Representa el contenido del PDF tal como está, es decir, sin formato.

Namespace: Documentize
Assembly: Documentize.dll

Enum TextFormattingMode

Información

Define diferentes modos que se pueden usar al convertir un documento PDF en texto. Consulta la clase Documentize.ExtractTextOptions.

public enum TextFormattingMode

Campos

Flatten = 2: Representa el contenido PDF con fragmentos de texto posicionados por sus coordenadas. Es básicamente similar al modo “Raw”. Pero mientras “Raw” se enfoca en preservar la estructura de los fragmentos de texto (operadores) en un documento, “Flatten” se enfoca en mantener el texto en el orden en que se lee.
Pure = 0: Representa el contenido de texto PDF con algunas rutinas de formato. Esto incluye tener en cuenta posiciones relativas y agregar espacios adicionales para alinear el texto al ancho de la página.
Raw = 1: Representa el contenido PDF tal como está, es decir, sin formateo.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffColorDepth

Información

Se utiliza para especificar la Profundidad de Color para las Documentize.PdfToTiffOptions.

public enum TiffColorDepth

Fields

Format1bpp = 4: 1 bit por píxel.
Format24bpp = 1: 24 bits por píxel. Rgb.
Format32bpp = 0: 32 bits por píxel. Usado por defecto.
Format4bpp = 3: 4 bits por píxel.
Format8bpp = 2: 8 bits por píxel.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffCompression

Información

Se utiliza para especificar el tipo de compresión para las opciones Documentize.PdfToTiffOptions.

public enum TiffCompression

Campos

CCITT3 = 2: Especifica el esquema de compresión CCITT3. Se puede pasar al codificador CCITT3 como un parámetro que pertenece a la categoría de compresión.
CCITT4 = 1: Especifica el esquema de compresión CCITT4. Se puede pasar al codificador CCITT4 como un parámetro que pertenece a la categoría de compresión.
LZW = 0: Especifica el esquema de compresión LZW. Se puede pasar al codificador Tiff como un parámetro que pertenece a la categoría de compresión.
None = 4: Especifica que no hay compresión. Se puede pasar al codificador Tiff como un parámetro que pertenece a la categoría de compresión.
RLE = 3: Especifica el esquema de compresión RLE. Se puede pasar al codificador RLE como un parámetro que pertenece a la categoría de compresión.

Namespace: Documentize Assembly: Documentize.dll

Información de Clase

Información

La clase proporciona información sobre la versión actual del producto.

public static class Info

Herencia

object ← Info

Miembros Heredados

Campos

AssemblyVersion Versión de la Asambía.

Valor del Campo

Producto

Nombre del Producto.

public const string Product = "Documentize"

Valor del Campo

Namespace: Documentize Assembly: Documentize.dll

Interface IDataSource

Información

Interfaz de datos general que define miembros comunes que los datos concretos deben implementar.

public interface IDataSource

Propiedades

DataType

Tipo de fuente de datos.

DataType DataType { get; }

Valor de la Propiedad

Namespace: Documentize Assembly: Documentize.dll

Interface IOperationResult

Información

Interfaz general de resultado de operación que define métodos comunes que el resultado de operación del plugin concreto debe implementar.

public interface IOperationResult

Propiedades

Data

Obtiene datos en bruto.

object Data { get; }

Valor de la propiedad

IsFile

Indica si el resultado es una ruta a un archivo de salida.

bool IsFile { get; }

Valor de la propiedad

IsStream

Indica si el resultado es un flujo de salida.

bool IsStream { get; }

Valor de la propiedad

IsString

Indica si el resultado es una cadena de texto.

bool IsString { get; }

Valor de la propiedad