Documentize Namespace

Model

El modelo utilizado para la finalización del chat.

[JsonProperty("model")]
public string Model { get; set; }

Valor de la propiedad

Object

El tipo de objeto, que siempre es chat.completion.

[JsonProperty("object")]
public string Object { get; set; }

Valor de la propiedad

SystemFingerprint

Esta huella digital representa la configuración del backend con la que se ejecuta el modelo.

[JsonProperty("system_fingerprint")]
public string SystemFingerprint { get; set; }

Valor de la propiedad

Usage

Estadísticas de uso para la solicitud de finalización.

[JsonProperty("usage")]
public Usage Usage { get; set; }

Valor de la propiedad

Usage

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptConsts

Información

Esta clase representa un almacenamiento para constantes.

public static class ChatGptConsts

Herencia

object ← ChatGptConsts

Miembros heredados

Campos

ApiUrl

Valor del campo

ModelName

public static string ModelName

Valor del campo

SystemRole

public static string SystemRole

Valor del campo

SystemRoleDescription

public static string SystemRoleDescription

Valor del campo

UserRole

public static string UserRole

Valor del campo

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptRequestOptions

Información

Representa opciones para el plugin Documentize.PdfManager.

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ChatGptRequestOptions

Implements

IPluginOptions

Inherited Members

Constructors

ChatGptRequestOptions()

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

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

Inicializa una nueva instancia del objeto Documentize.ChatGptRequestOptions con opciones específicas.

public ChatGptRequestOptions(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 cadena de solicitud a 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 null, lo que indica infinitas posibilidades.

public int? MaxTokens { get; set; }

Property Value

int?

Messages

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

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

Property Value

List<Message>

Remarks

Al agregar varios mensajes a las opciones, el orden en la colección es el siguiente:

El primer mensaje (si lo hay) proviene de options.Query, precedido por el mensaje con el contenido: “You are a helpful assistant.”, y el rol es "system".
Luego (si los hay) se añaden los mensajes de la colección options.Messages.
Finalmente se añaden los mensajes provenientes de fuentes de archivo (si los hay), un objeto mensaje por cada documento con el rol "user". Si no se proporciona ningún mensaje, se lanza una ArgumentException.

Model

Establece o obtiene el ID del modelo a utilizar.

public string Model { get; set; }

Property Value

NumberOfChoices

Cantidad de opciones de finalización de chat que se generarán para cada mensaje de entrada.

public int NumberOfChoices { get; set; }

Property Value

Query

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

public string Query { get; set; }

Property Value

Temperature

Temperatura de muestreo a utilizar, 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 Choice

Información

Una opción de finalización de chat.

public class Choice

Herencia

object ← Choice

Miembros heredados

Constructores

Choice()

public Choice()

Propiedades

FinishReason

La razón por la cual el modelo dejó de generar tokens. Esto se detendrá si el modelo alcanza un punto de parada natural o una secuencia de parada proporcionada, longitud si se alcanzó el número máximo de tokens especificado en la solicitud.

[JsonProperty("finish_reason")]
public string FinishReason { get; set; }

Valor de la propiedad

Index

El índice de la opción en la lista de opciones.

[JsonProperty("index")]
public int Index { get; set; }

Valor de la propiedad

Message

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

[JsonProperty("message")]
public Message Message { get; set; }

Valor de la propiedad

Message

Namespace: Documentize Assembly: Documentize.dll

Class CompressOptions

Información

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

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← CompressOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

CompressOptions()

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

public CompressOptions()

Namespace: Documentize Assembly: Documentize.dll

Class DecryptionOptions

Información

Representa las Opciones de Desencriptación para el complemento Documentize.Security.

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← DecryptionOptions

Implementa

IPluginOptions

Miembros Heredados

Constructores

DecryptionOptions(string)

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

public DecryptionOptions(string ownerPassword)

Parámetros

ownerPassword string: Contraseña del propietario.

Propiedades

OwnerPassword

Contraseña del propietario.

public string OwnerPassword { get; set; }

Valor de la Propiedad

Namespace: Documentize Assembly: Documentize.dll

Class DecryptOptions

Información

Representa opciones de descifrado para el complemento Documentize.PdfSecurity.

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← DecryptOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

DecryptOptions(string)

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

public DecryptOptions(string ownerPassword)

Parámetros

ownerPassword string: Contraseña del propietario.

Propiedades

OwnerPassword

Contraseña del propietario.

public string OwnerPassword { get; set; }

Valor de la propiedad

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class DirectoryData

Información

Representa datos del directorio para operaciones de carga y guardado.

public sealed class DirectoryData : IData

Herencia

object ← DirectoryData

Implementa

IData

Miembros heredados

Constructores

DirectoryData(string)

Inicializa nuevos datos del directorio con la ruta especificada.

public DirectoryData(string path)

Parámetros

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

Propiedades

DataType

Tipo de origen 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

Espacio de nombres: Documentize Ensamblado: 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 a formato DOC/DOCX.

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

Herencia

object ← DocConverter

Miembros heredados

Métodos

Process(PdfToDocOptions)

Convierte un documento PDF a formato DOC/DOCX.

public static ResultContainer Process(PdfToDocOptions options)

Parámetros

options PdfToDocOptions: 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 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 EncryptOptions

Información

Representa opciones de cifrado para el plugin Documentize.PdfSecurity.

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← EncryptOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

EncryptOptions(string, string)

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

public EncryptOptions(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

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class ExtractFormDataToDsvOptions

Información

Representa opciones para exportar valores de campos para los plugins Documentize.PdfForm y 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 delimiter = ',', bool addFieldNames = false)

Parámetros

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

Propiedades

AddFieldName

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

public bool AddFieldName { get; set; }

Valor de la propiedad

Delimiter

Delimitador usado para los valores exportados.

public char Delimiter { get; set; }

Valor de la propiedad

char

Namespace: Documentize Assembly: Documentize.dll

Class ExtractImagesOptions

Información

Representa 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()

Namespace: Documentize Assembly: Documentize.dll

Class ExtractPropertiesOptions

Información

Representa las opciones de extracción de propiedades PDF para el plugin Documentize.PdfExtractor.

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Herencia

object ← OptionsWithInput ← ExtractPropertiesOptions

Implementa

IHaveInput

Miembros heredados

Constructores

ExtractPropertiesOptions()

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

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

Inicializa una nueva instancia del objeto Documentize.ExtractPropertiesOptions con los datos especificados.

public ExtractPropertiesOptions(IData data)

Parámetros

data IData: Los datos de entrada.

ExtractPropertiesOptions(string)

Inicializa una nueva instancia del objeto Documentize.ExtractPropertiesOptions con el archivo especificado.

public ExtractPropertiesOptions(string file)

Parámetros

file string: La ruta del archivo de entrada.

ExtractPropertiesOptions(Stream)

Inicializa una nueva instancia del objeto Documentize.ExtractPropertiesOptions con el flujo especificado.

public ExtractPropertiesOptions(Stream stream)

Parámetros

stream Stream: El flujo de entrada.

Propiedades

Input

Obtiene o establece los datos de entrada.

public override IData Input { get; set; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class ExtractTextOptions

Información

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

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Inheritance

object ← OptionsWithInput ← ExtractTextOptions

Implements

IHaveInput

Inherited Members

Constructors

ExtractTextOptions(TextFormattingMode)

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

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

formattingMode TextFormattingMode: El valor del modo de formato de texto.

ExtractTextOptions(IData, TextFormattingMode)

Inicializa una nueva instancia del objeto Documentize.ExtractTextOptions con los datos especificados.

public ExtractTextOptions(IData data, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

data IData: Los datos de entrada.
formattingMode TextFormattingMode: El valor del modo de formato de texto.

ExtractTextOptions(string, TextFormattingMode)

Inicializa una nueva instancia del objeto Documentize.ExtractTextOptions con el archivo especificado.

public ExtractTextOptions(string file, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

file string: La ruta del archivo de entrada.
formattingMode TextFormattingMode: El valor del modo de formato de texto.

ExtractTextOptions(Stream, TextFormattingMode)

Inicializa una nueva instancia del objeto Documentize.ExtractTextOptions con el flujo especificado.

public ExtractTextOptions(Stream stream, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

stream Stream: El flujo de entrada.
formattingMode TextFormattingMode: El valor del modo de formato de texto.

Properties

FormattingMode

Obtiene o establece el modo de formato.

public TextFormattingMode FormattingMode { get; set; }

Property Value

TextFormattingMode

Input

Obtiene o establece los datos de entrada.

public override IData Input { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class FileData

Información

Representa los datos del archivo para operaciones de carga y guardado.

public sealed class FileData : IData

Herencia

object ← FileData

Implementa

IData

Miembros heredados

Constructores

FileData(string)

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

public FileData(string path)

Parámetros

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

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

Espacio de nombres: Documentize Ensamblado: 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 FlattenFieldsOptions

Información

Representa opciones para aplanar campos en el documento mediante el plugin Documentize.PdfForm.

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← FlattenFieldsOptions

Implements

IPluginOptions

Inherited Members

Constructors

FlattenFieldsOptions()

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

public FlattenFieldsOptions()

Properties

SkipFields

La lista de campos que no se aplanarán.

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

Property Value

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class FormExporter

Información

Representa el plugin Documentize.FormExporter. Se utiliza para exportar valores de formulario de documentos PDF a un archivo DSV o CSV.

[Obsolete("The class will be deleted soon. Please use PdfExtractor or PdfForm class.")]
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 no se establecen opciones.

Espacio de nombres: Documentize Ensamblado: 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 complemento Documentize.FormFlattener. Se utiliza para aplanar campos en documentos PDF.

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

Inheritance

object ← FormFlattener

Inherited Members

Methods

GetFieldNames(string)

Obtiene los nombres de los campos en el documento PDF.

public static List<string> GetFieldNames(string path)

Parameters

path string: La ruta al documento PDF.

Returns

Lista de nombres en el documento PDF.

GetFieldNames(Stream) : Get Field Names in the PDF Document.

Obtiene los nombres de los campos en el documento PDF.

public static List<string> GetFieldNames(Stream stream)

Parameters

stream Stream: El flujo con el documento PDF.

Returns

Lista de nombres en el documento PDF.

Process(FlattenFieldsOptions) : Flatten Form fields in PDF document.

Aplana los campos del formulario en el documento PDF.

public static ResultContainer Process(FlattenFieldsOptions options)

Parameters

options FlattenFieldsOptions: 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 las opciones no están configuradas.

Espacio de nombres: Documentize Ensamblado: 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

Namespace: Documentize Assembly: Documentize.dll

Class GetFieldNamesOptions

Información

Representa opciones para Get Field Names en un documento mediante el plugin Documentize.PdfForm.

public class GetFieldNamesOptions

Herencia

object ← GetFieldNamesOptions

Miembros heredados

Constructores

GetFieldNamesOptions(string)

Constructor para opciones con la ruta de entrada al archivo.

public GetFieldNamesOptions(string path)

Parámetros

path string: Ruta de entrada al archivo.

GetFieldNamesOptions(Stream)

Constructor para opciones con el flujo de entrada.

public GetFieldNamesOptions(Stream stream)

Parámetros

stream Stream: Flujo de entrada.

Espacio de nombres: Documentize Ensamblado: 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.

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

Herencia

object ← HtmlConverter

Miembros heredados

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.

Devuelve

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

Excepciones

Si no se establecen opciones.

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.

Devuelve

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

Excepciones

Si no se establecen opciones.

Namespace: Documentize Assembly: Documentize.dll

Class HtmlToPdfOptions

Información

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

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← HtmlToPdfOptions

Implements

IPluginOptions

Inherited Members

Constructors

HtmlToPdfOptions()

Inicializa una nueva instancia del objeto Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Properties

BasePath

La ruta/base URL para el archivo HTML.

public string BasePath { get; set; }

Property Value

HtmlMediaType

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

public HtmlMediaType HtmlMediaType { get; set; }

Property Value

HtmlMediaType

IsRenderToSinglePage

Obtiene o establece si se renderiza todo el documento en una sola página.

public bool IsRenderToSinglePage { get; set; }

Property Value

PageInfo

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

public PageInfo PageInfo { get; set; }

Property Value

PageInfo

PageLayoutOption

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

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Property Value

HtmlPageLayoutOption

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class ImageExtractor

Información

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

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

Herencia

object ← ImageExtractor

Miembros heredados

Métodos

Process(ExtractImagesOptions)

Extraer imágenes de un documento 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 Info

Información

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

public static class Info

Herencia

object ← Info

Miembros heredados

Campos

AssemblyVersion Versión del ensamblado.

Valor del campo

Producto

Nombre del producto.

public const string Product = "Documentize"

Valor del campo

Namespace: Documentize Assembly: Documentize.dll

Class JpegConverter

Información

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

[Obsolete("La clase se eliminará pronto. Por favor, utiliza la clase PdfConverter.")]
public static class JpegConverter

Herencia

object ← JpegConverter

Miembros heredados

Métodos

Process(PdfToJpegOptions)

Convierte un documento PDF en formato JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Parámetros

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

Retornos

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

Excepciones

Si no se han configurado las opciones.

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 solo PDF.

[Obsolete("La clase se eliminará pronto. Por favor, use la clase PdfManager.")]
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.

Devuelve

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

Excepciones

Si no se configuran las opciones.

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

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

IPluginOptions

Inherited Members

Constructors

OptimizeOptions()

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

abrir la primera página lo más rápido posible;
mostrar la página siguiente o seguir el enlace a la página siguiente lo más rápido posible;
mostrar la página de forma incremental a medida que llega, cuando los datos de una página se entregan por un canal lento (mostrar primero los datos más útiles);
permitir que la interacción del usuario, como seguir un enlace, se realice 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 complemento Documentize.Optimizer. Se utiliza para optimizar, rotar, cambiar el tamaño y comprimir documentos PDF.

[Obsolete("La clase será eliminada pronto. Por favor, use la clase PdfManager.")]
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.

Devuelve

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.

Devuelve

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.

Devuelve

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.

Devuelve

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

Namespace: Documentize Assembly: Documentize.dll

Class OptionsWithInput

Información

Representa las opciones base para operaciones con 1 dato de entrada.

public abstract class OptionsWithInput : IHaveInput

Herencia

object ← OptionsWithInput

Derivadas

Implementa

IHaveInput

Miembros heredados

Campos

input

Valor del campo

Propiedades

Input

Obtiene o establece los datos de entrada.

public virtual IData Input { get; set; }

Valor de la propiedad

Espacio de nombres: Documentize Ensamblado: 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 con PDF/A.

[Obsolete("La clase se eliminará pronto. Por favor, utiliza la clase PdfConverter.")]
public static class PdfAConverter

Herencia

object ← PdfAConverter

Miembros heredados

Métodos

Process(PdfToPdfAOptions)

Convierte un documento PDF en formato PDF/A.

public static ResultContainer Process(PdfToPdfAOptions options)

Parámetros

options PdfToPdfAOptions: 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(PdfAValidateOptions)

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

public static ResultContainer Process(PdfAValidateOptions options)

Parámetros

options PdfAValidateOptions: 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 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 plugin Documentize.PdfAConverter. Esta clase proporciona propiedades y métodos para configurar el proceso de conversión y validación PDF/A.

Representa la clase base para las opciones del plugin Documentize.PdfAConverter.
Esta clase proporciona propiedades y métodos para configurar el proceso de conversión y validación 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 requieren medios adicionales para preservar la alineación del texto durante el proceso de conversión PDF/A.

public bool AlignText { get; set; }

Property Value

Remarks

Cuando se establece en true, el proceso de conversión intentará restaurar los límites originales del segmento de texto.
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 los indicadores que controlan la conversión PDF/A en los casos en que el documento PDF de origen no se ajuste a la especificación PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Property Value

ErrorAction

Obtiene o establece la acción a realizar para los objetos que no pueden convertirse.

public ConvertErrorAction ErrorAction { get; set; }

Property Value

ConvertErrorAction

IccProfileFileName

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

public string IccProfileFileName { get; set; }

Property Value

Inputs

Obtiene la colección de datos.

public List<idata> Inputs { get; }

Property Value

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

Property Value

LogOutputSource

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

public IData LogOutputSource { get; set; }

Property Value

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Property Value

Remarks

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

PdfAVersion

Obtiene o establece la versión del estándar PDF/A que se utilizará para la validación o conversión.

public PdfAStandardVersion PdfAVersion { get; set; }

Property Value

PdfAStandardVersion

Remarks

La versión del estándar PDF/A se utiliza para determinar el nivel de cumplimiento para la validación y conversión PDF/A.
Si la versión se establece en Documentize.PdfAStandardVersion.Auto, el sistema determinará automáticamente la versión de estándar PDF/A adecuada para la validación en función de los metadatos del documento.
Para el proceso de conversión PDF/A, Documentize.PdfAStandardVersion.Auto se traduce al estándar PDF/A-1b de forma predeterminada.

SoftMaskAction

Obtiene o establece la acción a realizar durante la conversión de imágenes con máscaras suaves.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Property Value

ConvertSoftMaskAction

Methods

AddInput(IData)

Agrega nuevos datos a la colección

public void AddInput(IData data)

Parameters

data IData: Datos de entrada. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidateOptions

Información

Representa opciones para la validación del cumplimiento PDF/A de documentos PDF con el plugin Documentize.PdfConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Herencia

object ← PdfAOptionsBase ← PdfAValidateOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

PdfAValidateOptions()

public PdfAValidateOptions()

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class PdfAValidationResult

Información

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

public sealed class PdfAValidationResult

Inheritance

object ← PdfAValidationResult

Inherited Members

Fields

Data Obtiene la fuente de datos que se validó.

Field Value

IsValid

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

public readonly bool IsValid

Field Value

ArgumentException : InvalidOperationException

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

Field Value

PdfAStandardVersion

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGpt

Información

Representa el plugin PdfChatGpt.

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

Herencia

object ← PdfChatGpt

Miembros heredados

Observaciones

El Documentize.PdfChatGpt se utiliza para enviar solicitudes a ChatGPT directamente o añadiendo 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.

Devuelve

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.

Devuelve

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 PdfConverter

Información

Representa el plug‑in Documentize.PdfConverter. Se utiliza para convertir documentos PDF a otros formatos como DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. También permite realizar la validación PDF/A y convertir HTML a PDF.

Represents Documentize.PdfConverter plugin. Used to Convert PDF documents to another formats like DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A.
Also allows you to perform PDF/A Validation and Convert HTML to PDF.

public static class PdfConverter

Inheritance

object ←
PdfConverter

Inherited Members

Methods

Convert(PdfToDocOptions)

Converts PDF document into DOC/DOCX formats.

public static ResultContainer Convert(PdfToDocOptions options)

Parameters

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

Returns

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

Examples

The example demonstrates how to convert PDF document to Doc format.

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_file.doc"));
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document to Doc format with setting Mode.

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_file.doc"));
// Set Mode
options.Mode = DocConversionMode.Flow;
// Perform the process
PdfConverter.Convert(options);

Exceptions

If options not set.

Convert(PdfToXlsOptions)

Converts PDF document into XLSX/XLS/CSV/XLSM/ODS formats.

public static ResultContainer Convert(PdfToXlsOptions options)

Parameters

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

Returns

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

Examples

The example demonstrates how to convert PDF to XLSX document.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_xlsx_file.xlsx"));
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF to XLS document.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Specify XLS format
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// Set output file path
options.AddOutput(new FileData("path_to_result_xlsx_file.xls"));
 // Perform the process
PdfConverter.Convert(options);

Exceptions

If options not set.

Convert(PdfToHtmlOptions)

Converts PDF document into HTML format.

public static ResultContainer Convert(PdfToHtmlOptions options)

Parameters

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

Returns

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

Examples

The example demonstrates how to convert PDF to HTML document.

// Create PdfToHtmlOptions object to set output data type as file with embedded resources
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.html"));
//Perform the process
PdfConverter.Convert(options);

Exceptions

If options not set.

Convert(HtmlToPdfOptions)

Converts HTML document into PDF format.

public static ResultContainer Convert(HtmlToPdfOptions options)

Parameters

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

Returns

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

Examples

The example demonstrates how to convert HTML to PDF document.

// Create HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Add input file path
options.AddInput(new FileData("path_to_input.html"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
//Perform the process
PdfConverter.Convert(options);

Exceptions

If options not set.

Convert(PdfToJpegOptions)

Converts PDF document into JPEG format.

public static ResultContainer Convert(PdfToJpegOptions options)

Parameters

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

Returns

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

Examples

The example demonstrates how to convert PDF document into JPEG format.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into JPEG format with settings for pages, resolution, quality.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Process only the first page
options.PageList = [1];
// Set output resolution to 200 DPI
options.OutputResolution = 200;
// Set output quality to 50
options.Quality = 50;
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
 // Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
 // Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into JPEG format to streams.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Exceptions

If options not set.

Convert(PdfToPngOptions)

Converts PDF document into PNG format.

public static ResultContainer Convert(PdfToPngOptions options)

Parameters

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

Returns

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

Examples

The example demonstrates how to convert PDF document into PNG format.

// Create PdfToPngOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert 1 page of PDF document into PNG format.

// Create PdfToPngOptions object to set instructions
var options = new PdfToPngOptions()
// Process only the first page
options.PageList = [1];
// Set output resolution to 200 DPI
options.OutputResolution = 200;
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into PNG format to streams.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Exceptions

If options not set.

Convert(PdfToTiffOptions)

Converts PDF document into TIFF format.

public static ResultContainer Convert(PdfToTiffOptions options)

Parameters

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

Returns

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

Examples

The example demonstrates how to convert PDF document into TIFF format.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into TIFF format with Customizing Pages and DPI.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Set Pages
options.PageList = [1, 3];
// Set result image Resolution
options.OutputResolution = 400;
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into TIFF as Multi-Page.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Enable Multi-Page TIFF output
options.MultiPage = true;
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into TIFF format with Customizing Compression and ColorDepth.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Set Compression and ColorDepth
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into TIFF format to streams.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Exceptions

If options not set.

Convert(PdfToPdfAOptions)

Converts PDF document into PDF/A format.

public static ResultContainer Convert(PdfToPdfAOptions options)

Parameters

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

Returns

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

Examples

The example demonstrates how to convert the PDF document in a PDF/A format (PDF/A-3b in this case):

// Create the options class to set up the conversion process
var options = new PdfToPdfAOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Add the source file
options.AddInput(new FileData("path_to_your_pdf_file.pdf")); // replace with your actual file path

// Add the path to save the converted file
options.AddOutput(new FileData("path_to_the_converted_file.pdf"));

// Run the conversion
PdfConverter.Convert(options);

Exceptions

If options not set.

Validate(PdfAValidateOptions)

Check PDF document for compliance with specified format PDF/A.

public static ResultContainer Validate(PdfAValidateOptions options)

Parameters

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

Returns

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

Examples

The example demonstrates how to validate the PDF document conformance to PDF/A format (PDF/A-1a in this case):

// Create the options class to set up the validation process
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Add one or more files to be validated
options.AddInput(new FileData("path_to_your_first_pdf_file.pdf")); // replace with your actual file path
options.AddInput(new FileData("path_to_your_second_pdf_file.pdf"));
// add more files as needed

// Run the validation and get results
var resultContainer = PdfConverter.Validate(options);

// Check the resultContainer.ResultCollection property for validation results for each file:
foreach (var result in resultContainer.ResultCollection)
{
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Validation result for document
}

Exceptions

If options not set.

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 usa para extraer texto, imágenes, datos de formulario, propiedades (metadatos) de documentos PDF.

public static class PdfExtractor

Inheritance

object ← PdfExtractor

Inherited Members

Methods

Extract(ExtractTextOptions)

Extrae texto de un documento PDF.

public static string Extract(ExtractTextOptions options)

Parameters

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

Returns

string : Texto extraído.

Examples

El ejemplo muestra cómo extraer contenido de texto de un archivo PDF.

// Crear objeto ExtractTextOptions para establecer la ruta del archivo de entrada
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf");
// Ejecutar el proceso y obtener el texto extraído
var textExtracted = PdfExtractor.Extract(options);

El ejemplo muestra cómo extraer contenido de texto de un flujo PDF.

// Crear objeto ExtractTextOptions para establecer el flujo de entrada
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractTextOptions(stream);
// Ejecutar el proceso y obtener el texto extraído
var textExtracted = PdfExtractor.Extract(options);

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

// Crear objeto ExtractTextOptions para establecer la ruta del archivo y TextFormattingMode
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure);
// Ejecutar el proceso y obtener el texto extraído
var textExtracted = PdfExtractor.Extract(options);

El ejemplo muestra cómo extraer texto de un archivo PDF de la forma más breve posible.

// Ejecutar el proceso y obtener el texto extraído
var textExtracted = PdfExtractor.Extract(new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure));

Exceptions

Si no se establecen las opciones.

Extract(ExtractImagesOptions)

Extrae imágenes de un documento PDF.

public static ResultContainer Extract(ExtractImagesOptions options)

Parameters

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

Returns

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

Examples

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

// Crear ExtractImagesOptions para establecer las instrucciones
var options = new ExtractImagesOptions();
// Añadir ruta del archivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Establecer la ruta del directorio de salida
options.AddOutput(new DirectoryData("path_to_results_directory"));
// Ejecutar el proceso
var results = PdfExtractor.Extract(options);
// Obtener la ruta del resultado de la imagen
var imageExtracted = results.ResultCollection[0].ToFile();

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

// Crear ExtractImagesOptions para establecer las instrucciones
var options = new ExtractImagesOptions();
// Añadir ruta del archivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// No se establece salida – los resultados se escribirán en flujos
// Ejecutar el proceso
var results = PdfExtractor.Extract(options);
// Obtener el flujo
var ms = results.ResultCollection[0].ToStream();
// Copiar los datos a un archivo para la demostración
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

Exceptions

Si no se establecen las opciones.

Extract(ExtractFormDataToDsvOptions)

Extrae datos de formulario de un documento PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo exportar valores de formulario a un archivo CSV.

// Crear ExtractFormDataToDsvOptions para establecer las instrucciones
var options = new ExtractFormDataToDsvOptions(',', true);
// Añadir ruta del archivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Establecer la ruta del archivo de salida
options.AddOutput(new FileData("path_to_result_csv_file.csv"));
// Ejecutar el proceso
PdfExtractor.Extract(options);

El ejemplo muestra cómo exportar valores de formulario a un archivo TSV y establecer propiedades.

// Crear ExtractFormDataToDsvOptions para establecer las instrucciones
var options = new ExtractFormDataToDsvOptions();
//Establecer delimitador
options.Delimiter = '\t';
//Añadir nombres de campo al resultado
options.AddFieldName = true;
// Añadir ruta del archivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Establecer la ruta del archivo de salida
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Ejecutar el proceso
PdfExtractor.Extract(options);

Exceptions

Si no se establecen las opciones.

Extract(ExtractPropertiesOptions)

Extrae propiedades de un documento PDF.

public static PdfProperties Extract(ExtractPropertiesOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo extraer propiedades (FileName, Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) de un archivo PDF.

// Crear ExtractPropertiesOptions para establecer el archivo de entrada
var options = new ExtractPropertiesOptions("path_to_your_pdf_file.pdf");
// Ejecutar el proceso y obtener las propiedades
var pdfProperties = PdfExtractor.Extract(options);
var filename = pdfProperties.FileName;
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

El ejemplo muestra cómo extraer propiedades (Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) de un flujo PDF.

// Crear ExtractPropertiesOptions para establecer el flujo de entrada
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractPropertiesOptions(stream);
// Ejecutar el proceso y obtener las propiedades
var pdfProperties = PdfExtractor.Extract(options);
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

El ejemplo muestra cómo extraer propiedades de un archivo PDF de la forma más breve posible.

// Ejecutar el proceso y obtener las propiedades
var pdfProperties = PdfExtractor.Extract(new ExtractPropertiesOptions("path_to_your_pdf_file.pdf"));

Exceptions

Si no se establecen las opciones.

Namespace: Documentize Assembly: Documentize.dll

Class PdfForm

Información

Representa el plugin Documentize.PdfForm. Se usa para aplanar, extraer datos de formularios. También permite obtener los nombres de los campos.

public static class PdfForm

Inheritance

object ← PdfForm

Inherited Members

Methods

Extract(ExtractFormDataToDsvOptions)

Extrae datos del formulario de un documento PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo exportar los valores del formulario a un archivo CSV.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions(',', true);
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.csv"));
// Perform the process
PdfForm.Extract(options);

El ejemplo muestra cómo exportar los valores del formulario a un archivo TSV y establecer propiedades.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions();
//Set Delimiter
options.Delimiter = '\t';
//Add Field Names to result
options.AddFieldName = true;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Perform the process
PdfForm.Extract(options);

Exceptions

Si no se establecen las opciones.

Flatten(FlattenFieldsOptions)

Aplana campos en un documento PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Parameters

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

Returns

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

Examples

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

// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Flatten(options);

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

// Get Fields Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));
// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
PdfForm.Flatten(options);

Exceptions

Si no se establecen las opciones.

GetNames(GetFieldNamesOptions)

Obtiene los nombres de los campos en un documento PDF.

public static List<string> GetNames(GetFieldNamesOptions options)

Parameters

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

Returns

Lista de nombres en el documento PDF.

Examples

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

// Get Field Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));

Remove(RemoveFieldsOptions) : Remove Fields from PDF document.

public static ResultContainer Remove(RemoveFieldsOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo eliminar campos de un archivo PDF.

// Create RemoveFieldsOptions object to set instructions
var options = new RemoveFieldsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Remove(options);

Exceptions

Si no se establecen las opciones.

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

Información

Representa el plugin Documentize.PdfManager. Se utiliza para combinar, dividir, optimizar, rotar, cambiar el tamaño, comprimir documentos PDF y agregar tablas, agregar índice (TOC) a documentos PDF. Puede combinar varios documentos PDF en uno solo. Puede dividir documentos PDF en páginas separadas. Puede optimizar, rotar, cambiar el tamaño, comprimir documentos PDF. Puede rotar y cambiar el tamaño de páginas de un documento PDF. Puede agregar una tabla a un documento PDF. Puede agregar un índice a un documento PDF.

public static class PdfManager

Inheritance

object ← PdfManager

Inherited Members

Methods

AddTable(TableOptions)

Agregar una tabla al documento PDF.

public static ResultContainer AddTable(TableOptions options)

Parameters

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

Returns

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

Examples

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

// Configure table options
var options = new TableOptions();
options.InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .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");
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
PdfManager.AddTable(options);

El ejemplo muestra cómo agregar una tabla antes de la página 2.

// Configure table options
var options = new TableOptions();
options.InsertPageBefore(2) // Add table before page 2
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age");
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
PdfManager.AddTable(options);

Exceptions

Si no se establecen las opciones.

AddTableOfContents(TocOptions)

Agregar un índice (TOC) al documento PDF.

public static ResultContainer AddTableOfContents(TocOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo agregar un índice a un archivo PDF.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(options);

El ejemplo muestra cómo agregar un índice con generación de marcadores.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Generate links in bookmarks
options.GenerateBookmarks = true;
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.AddTableOfContents(options);

El ejemplo muestra cómo agregar un índice y guardarlo como flujo.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output stream 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Perform the process
PdfManager.AddTableOfContents(options);

El ejemplo muestra cómo personalizar el encabezado del índice.

// Create TocOptions object to set instructions
var heading = new TocHeading();
heading.Text = "Intro";
heading.PageNumber = 5;
heading.GenerateNumbering = true;
heading.Level = 2;
var tocOptions = new TocOptions();
tocOptions.Headings.Add(heading);
// Add input and output files
tocOptions.AddInput(new FileData("path_to_your_pdf_file.pdf"));
tocOptions.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Generate the TOC with customized options
PdfManager.AddTableOfContents(tocOptions);

Exceptions

Si no se establecen las opciones.

Compress(CompressOptions)

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

public static ResultContainer Compress(CompressOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo comprimir un documento PDF.

// Create CompressOptions object to set instructions
var options = new CompressOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Compress(options);

Exceptions

Si no se establecen las opciones.

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

Crear documento PDF a partir de la respuesta de ChatGpt. Se usa para enviar solicitudes a ChatGPT directamente o añadiendo fuentes de archivos PDF y guardar la respuesta en la fuente de salida.

public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

Parameters

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

Returns

Task<ResultContainer>

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

Examples

El ejemplo muestra cómo usar ChatGpt añadiendo mensajes a la solicitud.

var options = new ChatGptRequestOptions();
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); 
options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

// Add the request messages.
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
});

// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.

El ejemplo muestra cómo usar ChatGpt añadiendo un solo mensaje a la solicitud.

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); // Add the output file path.
options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

// Add the request message.
// In this case, the system message with Content = "You are a helpful assistant." is added by default.
// The role of the query message is "user" by default.
options.Query = "What is the lowest temperature recorded on the Earth?";

// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.

El ejemplo muestra cómo usar Chat añadiendo archivo(s) como fuente(s) del mensaje.

var options = new ChatGptRequestOptions();
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));

// Add the PDF text source.
// In case of multiple sources, the text from each document will be added to the request message collection
// as a separate message with the role "user".
options.AddInput(new FileData("TextSource.pdf"));

options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

// Add the request message.
// In this case, the system message with Content = "You are a helpful assistant." is added by default.
// The role of the query message is "user" by default.
options.Query = "How many letters in the provided text?";

// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.

Exceptions

ArgumentException : If options not set.

Merge(MergeOptions)

Combinar documentos PDF.

public static ResultContainer Merge(MergeOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo combinar dos documentos PDF.

// Create MergeOptions object to set instructions
var options = new MergeOptions();
// Add input file paths
options.AddInput(new FileData("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileData("path_to_your_pdf_file_2.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Merge(options);

Exceptions

Si no se establecen las opciones.

Optimize(OptimizeOptions)

Optimizar documento PDF. Linealizar el documento para:

abrir la primera página lo más rápido posible;
mostrar la siguiente página o seguir enlaces a la siguiente página lo más rápido posible;
mostrar la página de forma incremental a medida que llegan los datos en un canal lento (mostrar primero los datos más útiles);
permitir que la interacción del usuario, como seguir un enlace, se realice incluso antes de que se haya recibido y mostrado toda la página.

public static ResultContainer Optimize(OptimizeOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo optimizar un documento PDF.

// Create OptimizeOptions object to set instructions
var options = new OptimizeOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Optimize(options);

Exceptions

Si no se establecen las opciones.

Resize(ResizeOptions)

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

public static ResultContainer Resize(ResizeOptions options)

Parameters

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

Returns

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

Examples

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

// Create ResizeOptions object to set instructions
var options = new ResizeOptions();
// Set new PageSize
options.PageSize = PageSize.A3;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Resize(options);

Exceptions

Si no se establecen las opciones.

Rotate(RotateOptions)

Rotar páginas de un documento PDF.

public static ResultContainer Rotate(RotateOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo rotar un documento PDF.

// Create RotateOptions object to set instructions
var options = new RotateOptions();
// Set new Rotation
options.Rotation = Rotation.On90;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Rotate(options);

Exceptions

Si no se establecen las opciones.

Split(SplitOptions)

Dividir documento PDF por páginas.

public static ResultContainer Split(SplitOptions options)

Parameters

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

Returns

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

Examples

El ejemplo muestra cómo dividir un documento PDF.

// Create SplitOptions object to set instructions
var options = new SplitOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file paths
options.AddOutput(new FileData("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file_2.pdf"));
// Perform the process
PdfManager.Split(options);

Exceptions

Si no se establecen las opciones.

Namespace: Documentize Assembly: Documentize.dll

Class PdfProperties

Información

Representa propiedades e información meta del documento PDF.

public class PdfProperties

Herencia

object ← PdfProperties

Miembros heredados

Constructores

PdfProperties()

public PdfProperties()

Propiedades

Application

Obtiene o establece la aplicación PDF.

public string Application { get; set; }

Valor de la propiedad

Author

Obtiene o establece el autor PDF.

public string Author { get; set; }

Valor de la propiedad

Created

Obtiene o establece la fecha de creación del PDF.

public DateTime? Created { get; set; }

Valor de la propiedad

DateTime?

FileName

Obtiene o establece el nombre de archivo PDF, si está disponible.

public string FileName { get; set; }

Valor de la propiedad

Keywords

Obtiene o establece las palabras clave del PDF.

public string Keywords { get; set; }

Valor de la propiedad

Modified

Obtiene o establece la fecha de modificación del PDF.

public DateTime? Modified { get; set; }

Valor de la propiedad

DateTime?

NumberOfPages

Obtiene o establece el número de páginas del PDF.

public int NumberOfPages { get; set; }

Valor de la propiedad

PdfProducer

Obtiene o establece el productor del PDF.

public string PdfProducer { get; set; }

Valor de la propiedad

Subject

Obtiene o establece el asunto del PDF.

public string Subject { get; set; }

Valor de la propiedad

Title

Obtiene o establece el título del PDF.

public string Title { get; set; }

Valor de la propiedad

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class PdfSecurity

Información

Representa el plugin Documentize.PdfSecurity. Usado para Encriptar, Desencriptar y Firmar documentos PDF.

public static class PdfSecurity

Herencia

object ← PdfSecurity

Miembros heredados

Métodos

Decrypt(DecryptOptions)

Desencripta un documento PDF.

public static ResultContainer Decrypt(DecryptOptions options)

Parámetros

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

Retorna

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

Ejemplos

El ejemplo muestra cómo Desencriptar un documento PDF.

// Create DecryptOptions object to set instructions
var options = new DecryptOptions("123456");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Decrypt(options);

Excepciones

Si no se establecen las opciones.

Encrypt(EncryptOptions)

Encripta un documento PDF.

public static ResultContainer Encrypt(EncryptOptions options)

Parámetros

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

Retorna

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

Ejemplos

El ejemplo muestra cómo Encriptar un documento PDF.

// Create EncryptOptions object to set instructions
var options = new EncryptOptions("123456", "qwerty");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Encrypt(options);

Excepciones

Si no se establecen las opciones.

Sign(SignOptions)

Firma un documento PDF mediante firma digital.

public static ResultContainer Sign(SignOptions options)

Parámetros

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

Retorna

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

Ejemplos

El ejemplo muestra cómo Firmar un documento PDF.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Sign(options);

El ejemplo muestra 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 FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Sign(options);

El ejemplo muestra cómo Firmar un documento PDF con firma invisible.

var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Configure invisible signature
signOptions.Visible = false;
// Perform the process
PdfSecurity.Sign(options);

El ejemplo muestra cómo Firmar un documento PDF con opciones adicionales.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Optional parameters
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Perform the process
PdfSecurity.Sign(options);

El ejemplo muestra cómo Firmar un documento PDF con Timestamp.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file");
options.TimestampOptions = new TimestampOptions("server_url");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Sign(options);

Excepciones

PdfToHtmlOptions.SaveDataType

Si no se establecen las opciones.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToDocOptions

Información

Representa las opciones del convertidor de PDF a DOC para el plugin Documentize.PdfConverter.

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

Observaciones

Use el modo Documentize.DocConversionMode.TextBox cuando el documento resultante no será editado intensamente. Las cajas de texto son fáciles de modificar cuando no hay mucho que hacer.

Use el modo Documentize.DocConversionMode.Flow cuando el documento de salida necesita una edición posterior. Los párrafos y líneas de texto en el modo flujo permiten una fácil modificación del texto, pero los objetos de formato no compatibles 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 complemento Documentize.PdfConverter.

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 datos de salida especificado.

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

Parámetros

outputDataType PdfToHtmlOptions.SaveDataType: Tipo de datos de salida.

Propiedades

OutputDataType

Obtiene el tipo de datos 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.PdfConverter.

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 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>

Quality

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

public int Quality { get; set; }

Valor de la propiedad

Espacio de nombres: Documentize
Ensamblado: Documentize.dll

Class PdfToPdfAOptions

Información

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

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

Inheritance

object ← PdfAOptionsBase ← PdfToPdfAOptions

Implements

IPluginOptions

Inherited Members

Constructores

PdfToPdfAOptions()

public PdfToPdfAOptions()

Propiedades

Outputs

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

public List<idata> Outputs { get; }

Valor de la propiedad

Métodos

AddOutput(IData)

Agrega un nuevo destino de guardado de resultados.

public void AddOutput(IData data)

Parámetros

data IData: Destino (fuente de datos de archivo o flujo) para guardar los resultados de la operación. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPngOptions

Información

Representa las opciones del conversor de PDF a PNG para el plugin Documentize.PdfConverter.

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 opciones del convertidor PDF a TIFF para el plugin Documentize.PdfConverter.

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; }

Valor de la Propiedad

TiffColorDepth

Observaciones

El valor predeterminado es Documentize.TiffColorDepth.Format32bpp.

Compression

Obtiene o establece el tipo de compresión.

public TiffCompression Compression { get; set; }

Valor de la Propiedad

TiffCompression

Observaciones

El valor predeterminado es Documentize.TiffCompression.LZW.

MultiPage

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

public bool MultiPage { get; set; }

Valor de la Propiedad

OutputResolution

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

public int OutputResolution { get; set; }

Valor de la Propiedad

PdfToXlsOptions.ExcelFormat

PageList

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

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

Valor de la Propiedad

List<int>

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class PdfToXlsOptions

Información

Representa las opciones del conversor de PDF a XLS/XLSX para el plugin Documentize.PdfConverter.

public sealed class PdfToXlsOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToXlsOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToXlsOptions()

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

public PdfToXlsOptions()

Properties

Format

Formato de salida.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Property Value

InsertBlankColumnAtFirst

Establezca true si necesita insertar una columna en blanco como la primera columna de la hoja de cálculo. El valor predeterminado es false; significa que no se insertará la columna en blanco.

public bool InsertBlankColumnAtFirst { get; set; }

Property Value

MinimizeTheNumberOfWorksheets

Establezca true si necesita minimizar la cantidad de hojas de cálculo en el libro resultante. El valor predeterminado es false; significa que cada página PDF se guarda como una hoja de cálculo separada.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class PluginBaseOptions

Información

Representa las opciones base para complementos.

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 Entradas para la operación.

public List<idata> Inputs { get; }

Valor de la propiedad

Outputs

Devuelve los datos de Salidas para la operación.

public List<idata> Outputs { get; }

Valor de la propiedad

Métodos

AddInput(IData)

Añade nuevos datos a Entradas.

public void AddInput(IData data)

Parámetros

data IData: Datos a añadir.

AddOutput(IData)

Añade nuevos datos a Salidas.

public void AddOutput(IData data)

Parámetros

data IData: Datos a añadir. :

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class PngConverter

Información

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

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

Herencia

object ← PngConverter

Miembros heredados

Métodos

Process(PdfToPngOptions)

Convierte el 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.

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 RemoveFieldsOptions

Información

Representa opciones para eliminar campos en el documento mediante el complemento Documentize.PdfForm plugin.

public class RemoveFieldsOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← RemoveFieldsOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

RemoveFieldsOptions()

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

public RemoveFieldsOptions()

Espacio de nombres: Documentize Ensamblado: 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 el 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

Inheritance

object ← PluginBaseOptions ← RotateOptions

Implements

IPluginOptions

Inherited Members

Constructors

RotateOptions()

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

public RotateOptions()

Properties

Rotation

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

public Rotation Rotation { get; set; }

Property Value

Rotation

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class Security

Información

Representa el plugin Documentize.Security. Se utiliza para encriptar y desencriptar documentos PDF.

[Obsolete("La clase se eliminará pronto. Por favor, use la clase PdfSecurity.")]
public static class Security

Herencia

object ← Security

Miembros heredados

Métodos

Process(EncryptOptions)

Encriptar Documento PDF.

public static ResultContainer Process(EncryptOptions options)

Parámetros

options EncryptOptions: 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 establecidas.

Process(DecryptOptions)

Desencriptar Documento PDF.

public static ResultContainer Process(DecryptOptions options)

Parámetros

options DecryptOptions: 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 establecidas.

Namespace: Documentize Assembly: Documentize.dll

Class SignOptions

Información

Representa opciones de firma para el plugin Documentize.PdfSecurity.

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 del 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 flujo con el archivo pfx.
password string: La contraseña del 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 la 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

TimestampOptions

Opciones de marca de tiempo.

public TimestampOptions TimestampOptions { get; set; }

Valor de la propiedad

TimestampOptions

Visible

La visibilidad de la firma.

public bool Visible { get; set; }

Valor de la propiedad

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class SplitOptions

Información

Representa opciones de división para Documentize.PdfManager plugin.

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()

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class Splitter

Información

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

[Obsolete("La clase será eliminada pronto. Por favor, use la clase PdfManager.")]
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.

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 StreamData

Información

Representa datos de flujo para operaciones de carga y guardado.

public sealed class StreamData : IData

Herencia

object ← StreamData

Implementa

IData

Miembros heredados

Constructores

StreamData(Stream)

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

public StreamData(Stream data)

Parámetros

data Stream: Objeto Stream

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 datos (flujo).

public DataType DataType { get; }

Valor de la propiedad

Espacio de nombres: Documentize Ensamblado: 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("The class will be deleted soon. Please use PdfManager class.")]
public static class TableGenerator

Herencia

object ← TableGenerator

Miembros heredados

Ejemplos

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

// Configure table options
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .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");
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
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 las instrucciones para la operación.

Retorna

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

Excepciones

Si no se establece options.

Espacio de nombres: Documentize Ensamblado: Documentize.dll

Class TableOptions

Información

Representa opciones para agregar una tabla al documento mediante el plugin 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()

Agrega una tabla al documento.

public TableBuilder AddTable()

Devuelve

TableBuilder : Nueva instancia de Documentize.TableBuilder.

Create()

Crea una instancia de Documentize.TableOptions.

public static TableOptions Create()

Devuelve

TableOptions : Nueva instancia de Documentize.TableOptions.

InsertPageAfter(int)

Inserta una página después de la página especificada.

public TableOptions InsertPageAfter(int page)

Parámetros

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

Devuelve

TableOptions : Instancia del Documentize.TableOptions actual.

InsertPageBefore(int)

Inserta una página antes de la página especificada.

public TableOptions InsertPageBefore(int page)

Parámetros

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

Devuelve

TableOptions : Instancia del Documentize.TableOptions actual.

Espacio de nombres: Documentize
Ensamblado: 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 usa para extraer texto de documentos PDF.

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

Herencia

object ← TextExtractor

Miembros heredados

Métodos

Process(ExtractTextOptions)

Extrae texto de un documento PDF.

public static string Process(ExtractTextOptions options)

Parámetros

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

Devuelve

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

Excepciones

Si las opciones no están establecidas.

Espacio de nombres: Documentize Ensamblado: 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 en formato TIFF.

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

Herencia

object ← TiffConverter

Miembros Heredados

Métodos

Process(PdfToTiffOptions)

Convierte un documento PDF en 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. Utilizado para agregar una marca de tiempo a un documento.

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

Herencia

object ← Timestamp

Miembros heredados

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.

Excepciones

Si las opciones no están establecidas.

Namespace: Documentize Assembly: Documentize.dll

Class TimestampOptions

public class TimestampOptions

Herencia

object ← TimestampOptions

Miembros heredados

Constructores

TimestampOptions(string, string)

Inicializa una nueva instancia de la clase Documentize.TimestampOptions.

public TimestampOptions(string serverUrl, string basicAuthCredentials = "")

Parámetros

serverUrl string: La url del servidor de timestamp.
basicAuthCredentials string: Las credenciales de autenticación básica, el nombre de usuario y la contraseña se combinan en una cadena “username:password”.

Propiedades

BasicAuthCredentials

Obtiene/establece las credenciales de autenticación básica, el nombre de usuario y la contraseña se combinan en una cadena “username:password”.

public string BasicAuthCredentials { get; set; }

Valor de la propiedad

ServerUrl

Obtiene/establece la url del servidor de timestamp.

public string ServerUrl { get; set; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class TocGenerator

Información

Representa el plugin Documentize.TocGenerator. Se utiliza para añadir una tabla de contenidos a documentos PDF.

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

Herencia

object ← TocGenerator

Miembros heredados

Ejemplos

El ejemplo demuestra cómo añadir una tabla de contenidos a un archivo PDF.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

El ejemplo demuestra cómo añadir una tabla de contenidos a un archivo PDF generando marcadores.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Generate links in bookmarks
options.GenerateBookmarks = true;
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

El ejemplo demuestra cómo añadir una tabla de contenidos a un archivo PDF y guardarlo como flujo.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output stream 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Perform the process
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 las 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 opciones para agregar una tabla de contenido al documento mediante el plugin Documentize.PdfManager.

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← TocOptions

Implementa

IPluginOptions

Miembros heredados

Constructores

TocOptions()

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

public TocOptions()

Propiedades

GenerateBookmarks

Uso de la generación de marcadores. Si se establece true los marcadores se limpiarán y se generarán a partir de los encabezados; de lo contrario, los marcadores no cambiarán.

public bool GenerateBookmarks { get; set; }

Valor de la propiedad

Headings

Encabezados o títulos de la tabla de contenido.

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

Valor de la propiedad

List<TocHeading>

Title

El título de la tabla de contenidos.

public string Title { get; set; }

Valor de la propiedad

Namespace: Documentize Assembly: Documentize.dll

Class Usage

Información

Estadísticas de uso para la solicitud de finalización.

public class Usage

Herencia

object ← Usage

Miembros heredados

Constructores

Usage()

public Usage()

Propiedades

CompletionTokens

Número de tokens en la finalización generada.

[JsonProperty("completion_tokens")]
public int CompletionTokens { get; set; }

Valor de la propiedad

PromptTokens

Número de tokens en el prompt.

[JsonProperty("prompt_tokens")]
public int PromptTokens { get; set; }

Valor de la propiedad

TotalTokens

Número total de tokens utilizados en la solicitud (prompt + finalización).

[JsonProperty("total_tokens")]
public int TotalTokens { get; set; }

Valor de la propiedad

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.

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

Herencia

object ← XlsConverter

Miembros heredados

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

Firma de Clase

Información

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

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

Herencia

object ← Signature

Miembros heredados

Métodos

Process(SignOptions)

Firma un documento PDF.

public static ResultContainer Process(SignOptions options)

Parámetros

options SignOptions: 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

Interface IData

Información

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

public interface IData

Propiedades

DataType

Tipo de fuente de datos.

DataType DataType { get; }

Valor de la Propiedad

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 IHaveInput

Información

Interfaz de datos general que define los datos de entrada que Options debe implementar.

public interface IHaveInput

Properties

Input

Obtiene o establece los datos de entrada.

IData Input { get; set; }

Property Value

Espacio de nombres: Documentize Ensamblado: 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