Class AddTimestampOptions

[Obsolete("The class will be deleted soon. Please use SignOptions class.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← AddTimestampOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

AddTimestampOptions(Stream, string, string, string)

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

public AddTimestampOptions(Stream pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Parámetros

• pfx Stream: La ruta al archivo pfx.
• password string: La contraseña del archivo pfx.
• serverUrl string: La URL del servidor de sellado de tiempo.
• serverBasicAuthCredentials string: Las credenciales de autenticación básica; el nombre de usuario y la contraseña se combinan en una cadena “username:password”. (Opcional).

AddTimestampOptions(string, string, string, string)

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

public AddTimestampOptions(string pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Parámetros

• pfx string: La ruta al archivo pfx.
• password string: La contraseña del archivo pfx.
• serverUrl string: La URL del servidor de sellado de tiempo.
• serverBasicAuthCredentials string: Las credenciales de autenticación básica; el nombre de usuario y la contraseña se combinan en una cadena “username:password”. (Opcional).

Class ChatCompletion

public class ChatCompletion

Herencia

object ← ChatCompletion

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

ChatCompletion()

public ChatCompletion()

Propiedades

Choices

Una lista de opciones de finalización de chat. Puede haber más de una si n es mayor que 1.

[JsonProperty("choices")]
public List<choice> Choices { get; set; }

Valor de la propiedad

List<Choice>

Created

La marca de tiempo Unix (en segundos) de cuándo se creó la finalización de chat.

[JsonProperty("created")]
public long Created { get; set; }

Valor de la propiedad

long

Id

Un identificador único para la finalización de chat.

[JsonProperty("id")]
public string Id { get; set; }

Valor de la propiedad

string

Model

El modelo usado para la finalización de chat.

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

Valor de la propiedad

string

Object

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

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

Valor de la propiedad

string

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

string

Usage

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

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

Valor de la propiedad

Usage

Class ChatGptConsts

public static class ChatGptConsts

Herencia

object ← ChatGptConsts

Miembros heredados

• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

Campos

ApiUrl

public static string ApiUrl

Valor del campo

string

ModelName

public static string ModelName

Valor del campo

string

SystemRole

public static string SystemRole

Valor del campo

string

SystemRoleDescription

public static string SystemRoleDescription

Valor del campo

string

UserRole

public static string UserRole

Valor del campo

string

Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Herencia

object ←
PluginBaseOptions ←
ChatGptRequestOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

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)

Parámetros

• 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 a ChatGPT.

Propiedades

ApiKey

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

public string ApiKey { get; set; }

Valor de la propiedad

string

ApiUrl

Obtiene o establece la URL de la API de ChatGPT.

public string ApiUrl { get; set; }

Valor de la propiedad

string

CancellationToken

El token de cancelación.

public CancellationToken CancellationToken { get; set; }

Valor de la propiedad

CancellationToken

MaxTokens

Número máximo de tokens en la respuesta.
El valor predeterminado es null, lo que indica infinitos.

public int? MaxTokens { get; set; }

Valor de la propiedad

int?

Messages

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

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

Valor de la propiedad

List<Message>

Comentarios

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 con el rol “system”.
• Luego (si los hay) se añaden los mensajes de la colección options.Messages.
• Los mensajes de fuentes de archivo (si los hay) se añaden al final, un objeto mensaje por cada documento con el rol “user”.
  Si no se proporciona ningún mensaje, se lanza ArgumentException.

Model

Establece o obtiene el ID del modelo a utilizar.

public string Model { get; set; }

Valor de la propiedad

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Valor de la propiedad

int

Query

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

public string Query { get; set; }

Valor de la propiedad

string

Temperature

Temperatura de muestreo a usar, entre 0 y 2.
Valores más altos como 0.8 harán la salida 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; }

Valor de la propiedad

double

Class Choice

public class Choice

Inheritance

object ← Choice

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

Choice()

public Choice()

Properties

FinishReason

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

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

Property Value

string

Index

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

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

Property Value

int

Message

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

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

Property Value

Message

Class CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← CompressOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

CompressOptions()

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

public CompressOptions()

Class DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← DecryptionOptions

Implementa

• IPluginOptions

Miembros Heredados

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

string

Class DecryptOptions

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← DecryptOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData)
• PluginBaseOptions.AddOutput(IData)
• PluginBaseOptions.Inputs
• PluginBaseOptions.Outputs
• PluginBaseOptions.CloseInputStreams
• PluginBaseOptions.CloseOutputStreams
• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

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

string

Class DirectoryData

public sealed class DirectoryData : IData

Herencia

object ← DirectoryData

Implementa

• IData

Miembros heredados

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

DirectoryData(string)

Inicializa nuevos datos de 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

DataType

Path

Obtiene la ruta al directorio de los datos actuales.

public string Path { get; }

Valor de la propiedad

string

Class DirectoryDataSource

public sealed class DirectoryDataSource : IDataSource

Herencia

object ← DirectoryDataSource

Implementa

• IDataSource

Miembros heredados

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

DataType

Path

Obtiene la ruta al directorio de los datos actuales.

public string Path { get; }

Valor de la propiedad

string

Class DocConverter

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

Herencia

object ← DocConverter

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

Process(PdfToDocOptions)

Convierte un documento PDF al formato DOC/DOCX.

public static ResultContainer Process(PdfToDocOptions options)

Parámetros

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

Devuelve

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

Excepciones

ArgumentException

Si las opciones no están establecidas.

Class EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← EncryptionOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

string

UserPassword

Contraseña del usuario.

public string UserPassword { get; set; }

Valor de la propiedad

string

Class EncryptOptions

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← EncryptOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData)
• PluginBaseOptions.AddOutput(IData)
• PluginBaseOptions.Inputs
• PluginBaseOptions.Outputs
• PluginBaseOptions.CloseInputStreams
• PluginBaseOptions.CloseOutputStreams
• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

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

string

UserPassword

Contraseña del usuario.

public string UserPassword { get; set; }

Valor de la Propiedad

string

Class ExtractFormDataToDsvOptions

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Herencia

object ←
PluginBaseOptions ←
ExtractFormDataToDsvOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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 a usar en los datos exportados entre 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

bool

Delimiter

Delimitador usado para los valores exportados.

public char Delimiter { get; set; }

Valor de la propiedad

char

Class ExtractImagesOptions

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← ExtractImagesOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData)
• PluginBaseOptions.AddOutput(IData)
• PluginBaseOptions.Inputs
• PluginBaseOptions.Outputs
• PluginBaseOptions.CloseInputStreams
• PluginBaseOptions.CloseOutputStreams
• object.GetType()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

Constructores

ExtractImagesOptions()

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

public ExtractImagesOptions()

Class ExtractPropertiesOptions

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Herencia

object ← OptionsWithInput ← ExtractPropertiesOptions

Implementa

• IHaveInput

Miembros heredados

• OptionsWithInput.Input
• object.GetType()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

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 de entrada especificados.

public ExtractPropertiesOptions(IData inputData)

Parámetros

• inputData IData: Los datos de entrada.

ExtractPropertiesOptions(string)

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

public ExtractPropertiesOptions(string inputFile)

Parámetros

• inputFile string: La ruta del archivo de entrada.

ExtractPropertiesOptions(Stream)

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

public ExtractPropertiesOptions(Stream inputStream)

Parámetros

• inputStream Stream: El flujo de entrada.

Propiedades

Input

Obtiene o establece los datos de entrada.

public override IData Input { get; set; }

Valor de la propiedad

IData

Class ExtractTextOptions

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Herencia

object ←
OptionsWithInput ←
ExtractTextOptions

Implementa

• IHaveInput

Miembros heredados

• OptionsWithInput.Input,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

ExtractTextOptions(TextFormattingMode)

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

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parámetros

• formattingMode TextFormattingMode: 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)

Parámetros

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

Parámetros

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

Parámetros

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

Propiedades

FormattingMode

Obtiene o establece el modo de formato.

public TextFormattingMode FormattingMode { get; set; }

Valor de la propiedad

TextFormattingMode

Input

Obtiene o establece los datos de entrada.

public override IData Input { get; set; }

Valor de la propiedad

IData

Class FileData

public sealed class FileData : IData

Herencia

object ←
FileData

Implementa

• IData

Miembros heredados

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

DataType

Path

Obtiene la ruta al archivo de los datos actuales.

public string Path { get; }

Valor de la propiedad

string

Class FileDataSource

public sealed class FileDataSource : IDataSource

Herencia

object ← FileDataSource

Implementa

• IDataSource

Miembros heredados

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

DataType

Path

Obtiene la ruta al archivo de los datos actuales.

public string Path { get; }

Valor de la propiedad

string

Class FileResult

public sealed class FileResult : IOperationResult

Herencia

object ←
FileResult

Implementa

• IOperationResult

Miembros heredados

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Propiedades

Data

Obtiene los datos en bruto.

public object Data { get; }

Valor de la propiedad

object

IsFile

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

public bool IsFile { get; }

Valor de la propiedad

bool

IsStream

Indica si el resultado es un flujo de salida.

public bool IsStream { get; }

Valor de la propiedad

bool

IsString

Indica si el resultado es una cadena de texto.

public bool IsString { get; }

Valor de la propiedad

bool

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 de flujo.

public Stream ToStream()

Retorna

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

Class FlattenFieldsOptions

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← FlattenFieldsOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData)
• PluginBaseOptions.AddOutput(IData)
• PluginBaseOptions.Inputs
• PluginBaseOptions.Outputs
• PluginBaseOptions.CloseInputStreams
• PluginBaseOptions.CloseOutputStreams
• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

Constructores

FlattenFieldsOptions()

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

public FlattenFieldsOptions()

Propiedades

SkipFields

La lista de campos que no se aplanarán.

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

Valor de la propiedad

List<string>

Class FormExporter

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

Herencia

object ←
FormExporter

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Devuelve

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

Excepciones

ArgumentException
Si options no está configurado.

Class FormExportToDsvOptions

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← FormExportToDsvOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

bool

Delimeter

Delimitador utilizado para los valores exportados.

public char Delimeter { get; set; }

Valor de Propiedad

char

Class FormFlattener

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

Herencia

object ← FormFlattener

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

GetFieldNames(string)

Obtiene los nombres de campo en el documento PDF.

public static List<string> GetFieldNames(string path)

Parámetros

• path string: La ruta al documento PDF.

Devuelve

List<string>

Lista de nombres en el documento PDF.

GetFieldNames(Stream) : Obtiene los nombres de campo en el documento PDF.

public static List<string> GetFieldNames(Stream stream)

Parámetros

• stream Stream: El flujo que contiene el documento PDF.

Devuelve

List<string>

Lista de nombres en el documento PDF.

Process(FlattenFieldsOptions) : Aplana los campos del formulario en el documento PDF.

public static ResultContainer Process(FlattenFieldsOptions options)

Parámetros

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

Devuelve

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

Excepciones

ArgumentException

Si las opciones no están establecidas.

Class FormFlattenerOptions

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← FormFlattenerOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

FormFlattenerOptions()

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

public FormFlattenerOptions()

Propiedades

SkipFields

La lista de campos que no se aplanarán.

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

Valor de la propiedad

List<string>

Class GetFieldNamesOptions

public class GetFieldNamesOptions

Herencia

object ← GetFieldNamesOptions

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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.

Class HtmlConverter

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

Herencia

object ← HtmlConverter

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

Process(PdfToHtmlOptions)

Convierte documentos PDF al 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

ArgumentException

Si no se establecen las opciones.

Process(HtmlToPdfOptions)

Convierte documentos HTML al 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

ArgumentException

Si no se establecen las opciones.

Class HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← HtmlToPdfOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

HtmlToPdfOptions()

Inicializa una nueva instancia del objeto Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Propiedades

BasePath

La ruta/base URL del archivo HTML.

public string BasePath { get; set; }

Valor de la propiedad

string

HtmlMediaType

Obtiene o establece los tipos de medio posibles utilizados durante el renderizado.

public HtmlMediaType HtmlMediaType { get; set; }

Valor de la propiedad

HtmlMediaType

IsRenderToSinglePage

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

public bool IsRenderToSinglePage { get; set; }

Valor de la propiedad

bool

PageInfo

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

public PageInfo PageInfo { get; set; }

Valor de la propiedad

PageInfo

PageLayoutOption

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

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Valor de la propiedad

HtmlPageLayoutOption

Class ImageExtractor

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

Herencia

object ← ImageExtractor

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

Process(ExtractImagesOptions)

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

Devuelve

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

Excepciones

ArgumentException

Si no se establecen opciones.

Class ImageExtractorOptions

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← ImageExtractorOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

ImageExtractorOptions()

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

public ImageExtractorOptions()

Class Info

public static class Info

Herencia

object ← Info

Miembros heredados

• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

Campos

AssemblyVersion – Versión del ensamblado.

public const string AssemblyVersion = "26.7.0";

Valor del campo

string

Producto – Nombre del producto.

public const string Product = "Documentize";

Valor del campo

string

Class JpegConverter

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

Herencia

object ←
JpegConverter

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

Process(PdfToJpegOptions)

Convierte un documento PDF al formato JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Parámetros

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

Devuelve

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

Excepciones

ArgumentException
Si no se establece options.

Class License

public static class License

Herencia

object ← License

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Ejemplos

Muestra cómo activar una licencia.

// Set License
License.Set("PathToLicense.lic");

Métodos

Set(string)

Licencia el componente.

public static void Set(string licenseName)

Parámetros

• licenseName string: Puede ser un nombre de archivo completo o abreviado. Use una cadena vacía para cambiar al modo de evaluación.

Class MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← MergeOptions

Implementa

• IPluginOptions

Miembros heredados

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

MergeOptions()

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

public MergeOptions()

Class Merger

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

Herencia

object ← Merger

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

Process(MergeOptions)

Combina documentos PDF.

public static ResultContainer Process(MergeOptions options)

Parámetros

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

Devuelve

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

Excepciones

ArgumentException

Si no se establecen las opciones.

Class Message

public class Message

Herencia

object ← Message

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

Message()

public Message()

Propiedades

Content

El contenido del mensaje.

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

Valor de la propiedad

string

Role

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

Class ObjectResult

public sealed class ObjectResult : IOperationResult

Herencia

object ← ObjectResult

Implementa

• IOperationResult

Miembros heredados

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Propiedades

Data

Obtiene los datos sin procesar.

public object Data { get; }

Valor de la propiedad

object

IsFile

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

public bool IsFile { get; }

Valor de la propiedad

bool

IsObject

Indica si el resultado es un objeto.

public bool IsObject { get; }

Valor de la propiedad

bool

IsStream

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

public bool IsStream { get; }

Valor de la propiedad

bool

IsString

Indica si el resultado es una cadena.

public bool IsString { get; }

Valor de la propiedad

bool

Text

Devuelve la representación en cadena del resultado.

public string Text { get; }

Valor de la propiedad

string

Métodos

ToFile()

Intenta convertir el resultado a 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 a un objeto de flujo.

public Stream ToStream()

Devuelve

Stream : Un objeto Stream 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()

Devuelve

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

Class OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

#### Herencia

[object](https://learn.microsoft.com/dotnet/api/system.object) ←  
[PluginBaseOptions](Documentize.PluginBaseOptions.md) ←  
[OptimizeOptions](Documentize.OptimizeOptions.md)

#### Implementa

- [IPluginOptions](Documentize.IPluginOptions.md)

#### Miembros heredados

- [PluginBaseOptions.AddInput\(IData\)](Documentize.PluginBaseOptions.md\#Documentize\_PluginBaseOptions\_AddInput\_Documentize\_IData\_),
- [PluginBaseOptions.AddOutput\(IData\)](Documentize.PluginBaseOptions.md\#Documentize\_PluginBaseOptions\_AddOutput\_Documentize\_IData\_),
- [PluginBaseOptions.Inputs](Documentize.PluginBaseOptions.md\#Documentize\_PluginBaseOptions\_Inputs),
- [PluginBaseOptions.Outputs](Documentize.PluginBaseOptions.md\#Documentize\_PluginBaseOptions\_Outputs),
- [PluginBaseOptions.CloseInputStreams](Documentize.PluginBaseOptions.md\#Documentize\_PluginBaseOptions\_CloseInputStreams),
- [PluginBaseOptions.CloseOutputStreams](Documentize.PluginBaseOptions.md\#Documentize\_PluginBaseOptions\_CloseOutputStreams),
- [object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
- [object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring),
- [object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
- [object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
- [object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
- [object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

## Constructores

### <a id="Documentize_OptimizeOptions__ctor"></a> OptimizeOptions\(\)

Inicializa una nueva instancia del objeto Documentize.OptimizeOptions con opciones predeterminadas.  
Linealiza el documento con el fin de  
- 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 a través de 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 toda la página se haya recibido y mostrado.

```csharp
public OptimizeOptions()

Class Optimizer

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

Herencia

object ← Optimizer

Miembros heredados

• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

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

Devuelve

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

Class OptionsWithInput

public abstract class OptionsWithInput : IHaveInput

Herencia

object ← OptionsWithInput

Derivados

• ExtractPropertiesOptions
• ExtractTextOptions
• OptionsWithInputAndOutput

Implementa

• IHaveInput

Miembros heredados

• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

Campos

input

protected IData input;

Valor del campo

IData

Propiedades

Input

Obtiene o establece los datos de entrada.

public virtual IData Input { get; set; }

Valor de la propiedad

IData

Class OptionsWithInputAndOutput

public abstract class OptionsWithInputAndOutput : OptionsWithInput, IHaveInput

Herencia

object ← OptionsWithInput ← OptionsWithInputAndOutput

Derivado

• SanitizeOptions

Implementa

• IHaveInput

Miembros heredados

• OptionsWithInput.input
• OptionsWithInput.Input
• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

Campos

• output

  protected IData output

Valor del Campo

IData

Propiedades

Output

Obtiene o establece los datos de salida.

public virtual IData Output { get; set; }

Valor de la Propiedad

IData

Class PageInfo

public class PageInfo : PageSize

Herencia

object ← PageSize ← PageInfo

Miembros heredados

• PageSize.Width,
• PageSize.Height,
• PageSize.IsLandscape,
• PageSize.A0,
• PageSize.A1,
• PageSize.A2,
• PageSize.A3,
• PageSize.A4,
• PageSize.A5,
• PageSize.A6,
• PageSize.B5,
• PageSize.PageLetter,
• PageSize.PageLegal,
• PageSize.PageLedger,
• PageSize.P11x17,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

PageInfo()

Constructor of Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Constructor of Documentize.PageInfo.

public PageInfo(double width, double height)

Parámetros

• width double: Anchura de la página.
• height double: Altura de la página.

Propiedades

MarginBottom

Obtiene o establece un valor que indica el margen inferior.

public double MarginBottom { get; set; }

Valor de la propiedad

double

MarginLeft

Obtiene o establece un valor que indica el margen izquierdo.

public double MarginLeft { get; set; }

Valor de la propiedad

double

MarginRight

Obtiene o establece un valor que indica el margen derecho.

public double MarginRight { get; set; }

Valor de la propiedad

double

MarginTop

Obtiene o establece un valor que indica el margen superior.

public double MarginTop { get; set; }

Valor de la propiedad

double

Class PageSize

public class PageSize

Herencia

object ← PageSize

Derivados

• PageInfo

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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: Alto de la página.

Propiedades

A0

Tamaño A0 (1189x840 mm).

public static PageSize A0 { get; }

Valor de la propiedad

PageSize

A1

Tamaño A1 (840x594 mm).

public static PageSize A1 { get; }

Valor de la propiedad

PageSize

A2

Tamaño A2 (594x420 mm).

public static PageSize A2 { get; }

Valor de la propiedad

PageSize

A3

Tamaño A3 (420x297 mm).

public static PageSize A3 { get; }

Valor de la propiedad

PageSize

A4

Tamaño A4 (297x210 mm).

public static PageSize A4 { get; }

Valor de la propiedad

PageSize

A5

Tamaño A5 (210x148 mm).

public static PageSize A5 { get; }

Valor de la propiedad

PageSize

A6

Tamaño A6 (148x105 mm).

public static PageSize A6 { get; }

Valor de la propiedad

PageSize

B5

Tamaño B5 (250x176 mm).

public static PageSize B5 { get; }

Valor de la propiedad

PageSize

Height

Obtiene o establece la altura de la página.

public double Height { get; set; }

Valor de la propiedad

double

IsLandscape

Obtiene la orientación de la página. Devuelve true si es orientación horizontal y false si es vertical.

public bool IsLandscape { get; }

Valor de la propiedad

bool

P11x17

Formato 11x17 pulgadas.

public static PageSize P11x17 { get; }

Valor de la propiedad

PageSize

PageLedger

Tamaño Ledger (432x279 mm).

public static PageSize PageLedger { get; }

Valor de la propiedad

PageSize

PageLegal

Tamaño Legal (356x216 mm).

public static PageSize PageLegal { get; }

Valor de la propiedad

PageSize

PageLetter

Tamaño Letter (279x216 mm).

public static PageSize PageLetter { get; }

Valor de la propiedad

PageSize

Width

Obtiene o establece el ancho de la página.

public double Width { get; set; }

Valor de la propiedad

double

Class PdfAConverter

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

Herencia

object ← PdfAConverter

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

Process(PdfToPdfAOptions)

Convierte el documento PDF al formato PDF/A.

public static ResultContainer Process(PdfToPdfAOptions options)

Parámetros

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

Devuelve

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

Excepciones

ArgumentException

Si las opciones no están establecidas.

Process(PdfAValidateOptions)

Verifica que el documento PDF cumpla con el formato PDF/A especificado.

public static ResultContainer Process(PdfAValidateOptions options)

Parámetros

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

Devuelve

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

Excepciones

ArgumentException

Si las opciones no están establecidas.

Class PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Herencia

object ← PdfAOptionsBase ← PdfAConvertOptions

Implementa

• IPluginOptions

Miembros heredados

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

List<IDataSource>

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

Class PdfAOptionsBase

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

public abstract class PdfAOptionsBase : IPluginOptions

Herencia

object ←
PdfAOptionsBase

Derivados

• PdfAValidateOptions
• PdfToPdfAOptions

Implementa

• IPluginOptions

Miembros heredados

• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

Constructores

PdfAOptionsBase()

protected PdfAOptionsBase()

Propiedades

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 a PDF/A.

public bool AlignText { get; set; }

Valor de la propiedad

bool

Observaciones

Cuando se establece en true, el proceso de conversión intentará restaurar los límites originales de los fragmentos 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 varía durante el proceso de conversión predeterminado.

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Valor de la propiedad

bool

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

Valor de la propiedad

ConvertErrorAction

IccProfileFileName

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

public string IccProfileFileName { get; set; }

Valor de la propiedad

string

Inputs

Obtiene la colección de datos.

public List<idata> Inputs { get; }

Valor de la propiedad

List<IData>

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

Valor de la propiedad

bool

LogOutputSource

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

public IData LogOutputSource { get; set; }

Valor de la propiedad

IData

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Valor de la propiedad

bool

Observaciones

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

PdfAVersion

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

public PdfAStandardVersion PdfAVersion { get; set; }

Valor de la propiedad

PdfAStandardVersion

Observaciones

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 adecuada del estándar PDF/A para la validación en función de los metadatos del documento.
Para el proceso de conversión PDF/A, Documentize.PdfAStandardVersion.Auto se interpreta por defecto como la versión PDF/A-1b.

SoftMaskAction

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

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Valor de la propiedad

ConvertSoftMaskAction

Métodos

AddInput(IData)

Añade nuevos datos a la colección.

public void AddInput(IData data)

Parámetros

• data IData: Datos de entrada.

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Herencia

object ← PdfAOptionsBase ← PdfAValidateOptions

Implementa

• IPluginOptions

Miembros heredados

• PdfAOptionsBase.AddInput(IData),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

PdfAValidateOptions()

public PdfAValidateOptions()

Class PdfAValidationResult

public sealed class PdfAValidationResult

Herencia

object ← PdfAValidationResult

Miembros heredados

• object.GetType()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

Campos

Data

Obtiene la fuente de datos que se validó.

public readonly IData Data;

Valor del campo

IData

IsValid

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

public readonly bool IsValid;

Valor del campo

bool

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion;

Valor del campo

PdfAStandardVersion

Class PdfChatGpt

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

Inheritance

object ← PdfChatGpt

Inherited Members

• object.GetType()
• object.MemberwiseClone()
• object.ToString()
• object.Equals(object?)
• object.Equals(object?, object?)
• object.ReferenceEquals(object?, object?)
• object.GetHashCode()

Remarks

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.

Methods

Process(IPluginOptions)

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

public static ResultContainer Process(IPluginOptions options)

Parameters

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

Returns

ResultContainer

Exceptions

• NotImplementedException

ProcessAsync(IPluginOptions)

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

public static Task<ResultContainer> ProcessAsync(IPluginOptions options)

Parameters

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

Returns

Task<ResultContainer> – El objeto Task que representa la operación asíncrona.

Exceptions

• ArgumentException
• InvalidOperationException

Class PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Herencia

object ← PdfChatGptOptions

Derivados

• PdfChatGptRequestOptions

Implementa

• IPluginOptions

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructores

PdfChatGptOptions()

Inicializa una nueva instancia del objeto Documentize.PdfChatGptOptions.

public PdfChatGptOptions()

Propiedades

Inputs

public List<idatasource> Inputs { get; }

Valor de la Propiedad

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

Valor de la Propiedad

List<IDataSource>

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

Class PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Inheritance

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implements

• IPluginOptions

Inherited Members

• PdfChatGptOptions.AddInput(IDataSource),
• PdfChatGptOptions.AddOutput(IDataSource),
• PdfChatGptOptions.Inputs,
• PdfChatGptOptions.Outputs,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

string

ApiUrl

Obtiene o establece la URL de la API de ChatGPT.

public string ApiUrl { get; set; }

Property Value

string

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

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Property Value

int

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

string

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

double

Class PdfConverter

Representa el componente Documentize.PdfConverter. Se usa 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 validación PDF/A y convertir HTML a PDF.

public static class PdfConverter

Herencia

object ←
PdfConverter

Miembros heredados

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

Convert(PdfToDocOptions)

Convierte un documento PDF a formatos DOC/DOCX.

public static ResultContainer Convert(PdfToDocOptions options)

Parámetros

• options PdfToDocOptions: 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 convertir un documento PDF al formato Doc.

// 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);

El ejemplo muestra cómo convertir un documento PDF al formato Doc estableciendo el Modo.

// 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);

Excepciones

ArgumentException
Si no se establecen las opciones.

Convert(PdfToXlsOptions)

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

public static ResultContainer Convert(PdfToXlsOptions options)

Parámetros

• options PdfToXlsOptions: 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 convertir un PDF a documento XLSX.

// 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);

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

// 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);

Excepciones

ArgumentException
Si no se establecen las opciones.

Convert(PdfToHtmlOptions)

Convierte un documento PDF a formato HTML.

public static ResultContainer Convert(PdfToHtmlOptions options)

Parámetros

• options PdfToHtmlOptions: 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 convertir un PDF a documento HTML.

// 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);

Excepciones

ArgumentException
Si no se establecen las opciones.

Convert(HtmlToPdfOptions)

Convierte un documento HTML a formato PDF.

public static ResultContainer Convert(HtmlToPdfOptions options)

Parámetros

• options HtmlToPdfOptions: 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 convertir un documento HTML a PDF.

// 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);

Excepciones

ArgumentException
Si no se establecen las opciones.

Convert(PdfToJpegOptions)

Convierte un documento PDF a formato JPEG.

public static ResultContainer Convert(PdfToJpegOptions options)

Parámetros

• options PdfToJpegOptions: 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 convertir un documento PDF a formato JPEG.

// 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);

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

// 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);

El ejemplo muestra cómo convertir un documento PDF a formato JPEG a 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();
}

Excepciones

ArgumentException
Si no se establecen las opciones.

Convert(PdfToPngOptions)

Convierte un documento PDF a formato PNG.

public static ResultContainer Convert(PdfToPngOptions options)

Parámetros

• options PdfToPngOptions: 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 convertir un documento PDF a formato PNG.

// 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);

El ejemplo muestra cómo convertir una página del documento PDF a formato PNG.

// 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);

El ejemplo muestra cómo convertir un documento PDF a formato PNG a streams.

// Create PdfToPngOptions 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();
}