Acción ConvertSoftMask

public enum ConvertSoftMaskAction

Fields

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

Clase CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions  

Herencia

object ←
PluginBaseOptions ←
CompressOptions

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

CompressOptions()

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

public CompressOptions()  

Clase 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

Clase DocConverter

public sealed class DocConverter

Herencia

object ← DocConverter

Miembros heredados

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

Ejemplos

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

// crear DocConverter
var plugin = new DocConverter();
// crear objeto PdfToDocOptions para establecer instrucciones
var opt = new PdfToDocOptions();
// agregar ruta del archivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// establecer ruta del archivo de salida
opt.AddOutput(new FileDataSource(outputPath));
// realizar el proceso
plugin.Process(opt);

Constructores

DocConverter()

public DocConverter()

Métodos

Dispose()

Implementación de IDisposable.

public void Dispose()

Process(PdfToDocOptions)

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

public ResultContainer Process(PdfToDocOptions options)

Parámetros

• options PdfToDocOptions: Un objeto de opciones que contiene instrucciones para el Documentize.DocConverter.

Retorna

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

Clase 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

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

DataType

Path

Obtiene la ruta al archivo de los datos actuales.

public string Path { get; }

Valor de propiedad

string

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

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 de flujo que representa los datos de salida si el resultado es un flujo; de lo contrario, null.

Clase HtmlConverter

public sealed class HtmlConverter : IDisposable

Herencia

object ← HtmlConverter

Implementa

• IDisposable

Miembros heredados

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

Ejemplos

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

// crear HtmlConverter
var plugin = new HtmlConverter();
// crear objeto PdfToHtmlOptions para establecer el tipo de datos de salida como archivo con recursos incrustados
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// agregar ruta del archivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// establecer ruta del archivo de salida
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

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

// crear HtmlConverter
var plugin = new HtmlConverter();
// crear HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// agregar ruta del archivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// establecer ruta del archivo de salida
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Constructores

HtmlConverter()

public HtmlConverter()

Métodos

Dispose()

Implementación de IDisposable.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Parámetros

• options IPluginOptions: Un objeto de opciones que contiene instrucciones para el Documentize.HtmlConverter.

Devuelve

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

Clase HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← HtmlToPdfOptions

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

HtmlToPdfOptions()

Inicializa una nueva instancia del objeto Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Propiedades

BasePath

La ruta/base url para el archivo html.

public string BasePath { get; set; }

Valor de la Propiedad

string

HtmlMediaType

Obtiene o establece los tipos de medios posibles que se utilizan durante la representación.

public HtmlMediaType HtmlMediaType { get; set; }

Valor de la Propiedad

HtmlMediaType

IsRenderToSinglePage

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

public bool IsRenderToSinglePage { get; set; }

Valor de la Propiedad

bool

PageInfo

Obtiene o establece la información de la 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

Clase ImageExtractor

public class ImageExtractor : PdfExtractor, IDisposable

Herencia

object ← PdfExtractor ← ImageExtractor

Implementa

• IDisposable

Miembros heredados

• PdfExtractor.Process(IPluginOptions),
• PdfExtractor.Dispose(),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Ejemplos

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

// crear objeto ImageExtractor para extraer imágenes
using (var plugin = new ImageExtractor())
{
    // crear ImageExtractorOptions
    var opt = new ImageExtractorOptions();

    // agregar la ruta del archivo de entrada
    opt.AddInput(new FileDataSource(inputPath));
    // establecer directorio de salida
    opt.AddInput(new FileDataSource("D:\\"));

    // realizar el proceso de extracción
    var resultContainer = plugin.Process(opt);

    // obtener la imagen del objeto ResultContainer
    var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}

Constructores

ImageExtractor()

public ImageExtractor()

Clase ImageExtractorOptions

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions

Herencia

object ← PdfExtractorOptions ← ImageExtractorOptions

Implementa

• IPluginOptions

Miembros Heredados

• PdfExtractorOptions.AddInput(IDataSource),
• PdfExtractorOptions.Inputs,
• PdfExtractorOptions.OperationName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Observaciones

Hereda funciones para agregar datos (archivos, flujos) que representan documentos PDF de entrada.

Constructores

ImageExtractorOptions()

Inicializa una nueva instancia del objeto Documentize.ImageExtractorOptions.

public ImageExtractorOptions()

Propiedades

OperationName

Devuelve el nombre de la operación.

public override string OperationName { get; }

Valor de la Propiedad

string

Clase JpegConverter

public sealed class JpegConverter

Herencia

object ← JpegConverter

Miembros Heredados

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

Ejemplos

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

// crear JpegConverter
var plugin = new JpegConverter();
// crear objeto PdfToJpegOptions para establecer instrucciones
var opt = new PdfToJpegOptions();
// agregar ruta del archivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// establecer ruta del archivo de salida
opt.AddOutput(new DirectoryDataSource(outputPath));
// realizar el proceso
plugin.Process(opt);

Constructores

JpegConverter()

public JpegConverter()

Métodos

Process(PdfToJpegOptions)

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

public ResultContainer Process(PdfToJpegOptions options)

Parámetros

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

Retorna

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

Clase MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions  

Herencia

object ←
PluginBaseOptions ←
MergeOptions

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

MergeOptions()

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

public MergeOptions()  

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

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

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

Retorna

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

Clase OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← OptimizeOptions

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

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

public OptimizeOptions()

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

Clase PdfAConverter

public sealed class PdfAConverter

Herencia

object ← PdfAConverter

Miembros heredados

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

Ejemplos

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

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

// Agregar uno o más archivos a validar
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // reemplazar con la ruta real de su archivo
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// agregar más archivos según sea necesario

// Crear la instancia del complemento
var plugin = new PdfAConverter();

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

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

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

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

// Agregar el archivo fuente
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // reemplazar con la ruta real de su archivo

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

// Crear la instancia del complemento
var plugin = new PdfAConverter();

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

Constructores

PdfAConverter()

public PdfAConverter()

Métodos

Process(IPluginOptions)

Inicia un proceso de conversión o validación PDF/A con las opciones dadas.

public ResultContainer Process(IPluginOptions options)

Parámetros

• options IPluginOptions: Un objeto de opciones que contiene instrucciones para el complemento. Debe ser una instancia de la clase Documentize.PdfAConvertOptions o Documentize.PdfAValidateOptions.

Retorna

ResultContainer : Un objeto Documentize.ResultContainer que contiene el resultado del procesamiento.

Clase 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

Salidas

Obtiene la colección de destinos agregados (fuentes de datos de archivo o flujo) para los resultados de la operación de guardado.

public List<idatasource> Outputs { get; }

Valor de la propiedad

List<IDataSource&gt;

Métodos

AddOutput(IDataSource)

Agrega un nuevo destino de guardado para el resultado.

public void AddOutput(IDataSource dataSource)

Parámetros

• dataSource IDataSource: Destino (fuente de datos de archivo o flujo) para los resultados de la operación de guardado. :

Clase PdfAOptionsBase

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

public abstract class PdfAOptionsBase : IPluginOptions

Herencia

object ← PdfAOptionsBase

Derivadas

• PdfAConvertOptions,
• PdfAValidateOptions

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 son necesarios 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 Propiedad

bool

Observaciones

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

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Valor de Propiedad

bool

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

Valor de Propiedad

ConvertErrorAction

IccProfileFileName

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

public string IccProfileFileName { get; set; }

Valor de Propiedad

string

Inputs

Obtiene la colección de fuentes de datos

public List<idatasource> Inputs { get; }

Valor de Propiedad

List<IDataSource&gt;

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

Valor de Propiedad

bool

LogOutputSource

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

public IDataSource LogOutputSource { get; set; }

Valor de Propiedad

IDataSource

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Valor de 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 utilizará para validación o conversión.

public PdfAStandardVersion PdfAVersion { get; set; }

Valor de Propiedad

PdfAStandardVersion

Observaciones

La versión del estándar PDF/A se utiliza para determinar el nivel de conformidad para la validación y conversión a 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 a PDF/A, Documentize.PdfAStandardVersion.Auto se establece por defecto en la versión estándar 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 Propiedad

ConvertSoftMaskAction

Métodos

AddInput(IDataSource)

Agrega una nueva fuente de datos a la colección

public void AddInput(IDataSource dataSource)

Parámetros

• dataSource IDataSource:

Clase PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Herencia

object ← PdfAOptionsBase ← PdfAValidateOptions

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

PdfAValidateOptions()

public PdfAValidateOptions()

Clase 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

• DataSource Obtiene la fuente de datos que fue validada.

Valor del campo

IDataSource

IsValid

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

public readonly bool IsValid

Valor del campo

bool

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

Valor del campo

PdfAStandardVersion

Clase PdfChatGpt

public sealed class PdfChatGpt : IDisposable

Herencia

object ← PdfChatGpt

Implementa

• IDisposable

Miembros heredados

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

Ejemplos

El ejemplo demuestra cómo usar el complemento PdfChatGpt añadiendo mensajes a la solicitud.

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

    // Añadir los mensajes de la solicitud.
    options.Messages.Add(new Message
    {
        Content = "Eres un asistente útil.",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "¿Cuál es el diámetro de pizza más grande jamás hecho?",
        Role = Role.User
    });

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

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

El ejemplo demuestra cómo usar el complemento PdfChatGpt añadiendo un mensaje a la solicitud.

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

    // Añadir el mensaje de la solicitud.
    // En este caso, el mensaje del sistema con Content = "Eres un asistente útil." se añade por defecto.
    // El rol del mensaje de consulta es "user" por defecto.
    options.Query = "¿Cuál es la temperatura más baja registrada en la Tierra?";

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

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

El ejemplo demuestra cómo usar el complemento PdfChatGpt añadiendo archivos como fuente(s) de mensaje.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Añadir la ruta del archivo de salida.

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

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

    // Añadir el mensaje de la solicitud.
    // En este caso, el mensaje del sistema con Content = "Eres un asistente útil." se añade por defecto.
    // El rol del mensaje de consulta es "user" por defecto.
    options.Query = "¿Cuántas letras hay en el texto proporcionado?";

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

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

Observaciones

El objeto 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.

Constructores

PdfChatGpt()

Inicializa una nueva instancia del objeto Documentize.PdfChatGpt.

public PdfChatGpt()

Métodos

Dispose()

Implementación de IDisposable. De hecho, no es necesario para PdfChatGpt.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Parámetros

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

Retorna

ResultContainer : #### Excepciones

NotImplementedException

ProcessAsync(IPluginOptions)

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

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

Parámetros

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

Retorna

Task<ResultContainer&gt;

El objeto tarea que representa la operación asincrónica.

Excepciones

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

Establece el token de cancelación.

public void SetCancellationToken(CancellationToken cancellationToken)

Parámetros

• cancellationToken CancellationToken: El token de cancelación. :

Clase 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&gt;

Outputs

public List<idatasource> Outputs { get; }

Valor de la propiedad

List<IDataSource&gt;

Métodos

AddInput(IDataSource)

Agrega una nueva fuente de datos a la colección de datos del plugin 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 de guardado a la colección de datos del plugin PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

Parámetros

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

Clase PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Herencia

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implementa

• IPluginOptions

Miembros heredados

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

Constructores

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)

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 cadena de solicitud 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

MaxTokens

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

public int? MaxTokens { get; set; }

Valor de la propiedad

int?

Messages

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

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

Valor de la propiedad

List<Message&gt;

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 completado de chat generar para cada mensaje de entrada.

public int NumberOfChoices { get; set; }

Valor de la propiedad

int

Query

Obtiene o establece la cadena de solicitud a 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; }

Valor de la propiedad

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

Valor de la propiedad

double

Clase PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions

Herencia

object ← PdfConverterOptions

Derivados

• PdfToDocOptions,
• PdfToHtmlOptions,
• PdfToXlsOptions

Implementa

• IPluginOptions

Miembros heredados

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

Propiedades

Entradas

Devuelve la colección de datos del plugin PdfConverterOptions.

public List<idatasource> Inputs { get; }

Valor de la propiedad

List<IDataSource&gt;

Salidas

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

public List<idatasource> Outputs { get; }

Valor de la propiedad

List<IDataSource&gt;

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 para agregar.

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 stream) para guardar los resultados de la operación.

Excepciones

NotImplementedException

Clase PdfExtractor

public abstract class PdfExtractor : IDisposable

Herencia

object ← PdfExtractor

Derivados

• ImageExtractor,
• TextExtractor

Implementa

• IDisposable

Miembros heredados

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

Ejemplos

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

// crear objeto TextExtractor para extraer contenidos PDF
using (TextExtractor extractor = new TextExtractor())
{
    // crear objeto TextExtractorOptions para establecer instrucciones
    textExtractorOptions = new TextExtractorOptions();

    // agregar ruta del archivo de entrada
    textExtractorOptions.AddInput(new FileDataSource(inputPath));

    // realizar el proceso de extracción
    ResultContainer resultContainer = extractor.Process(textExtractorOptions);

    // obtener el texto extraído del objeto ResultContainer
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

Observaciones

El objeto Documentize.TextExtractor se utiliza para extraer texto, o Documentize.ImageExtractor para extraer imágenes.

Constructores

PdfExtractor()

protected PdfExtractor()

Métodos

Dispose()

Implementación de IDisposable. En realidad, no es necesario para PdfExtractor.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions pdfExtractorOptions)

Parámetros

• pdfExtractorOptions IPluginOptions: Un objeto de opciones que contiene instrucciones para el PdfExtractor.

Retorna

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

Clase PdfExtractorOptions

public abstract class PdfExtractorOptions : IPluginOptions

Herencia

object ← PdfExtractorOptions

Derivadas

• ImageExtractorOptions,
• TextExtractorOptions

Implementa

• IPluginOptions

Miembros heredados

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

Comentarios

La Documentize.PdfExtractorOptions contiene funciones base para agregar datos (archivos, flujos) que representan documentos PDF de entrada. Por favor, crea Documentize.TextExtractorOptions o ImageExtractorOptions en lugar de esto.

Propiedades

Inputs

Devuelve la colección de datos del plugin PdfExtractor.

public List<idatasource> Inputs { get; }

Valor de la propiedad

List<IDataSource&gt;

OperationName

Devuelve el nombre de la operación

public virtual string OperationName { get; }

Valor de la propiedad

string

Métodos

AddInput(IDataSource)

Agrega una nueva fuente de datos a la colección de datos del plugin PdfExtractor.

public void AddInput(IDataSource dataSource)

Parámetros

• dataSource IDataSource: Fuente de datos a agregar. :

Clase PdfToDocOptions

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions

Herencia

object ← PdfConverterOptions ← PdfToDocOptions

Implementa

• IPluginOptions

Miembros heredados

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

Constructores

PdfToDocOptions()

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

public PdfToDocOptions()

Clase PdfToHtmlOptions

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions

Herencia

object ← PdfConverterOptions ← PdfToHtmlOptions

Implementa

• IPluginOptions

Miembros heredados

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

Constructores

PdfToHtmlOptions()

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

public PdfToHtmlOptions()

PdfToHtmlOptions(SaveDataType)

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

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)

Parámetros

• outputDataType PdfToHtmlOptions.SaveDataType: Tipo de dato de salida.

Propiedades

OutputDataType

Obtiene el tipo de dato de salida.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Valor de la propiedad

PdfToHtmlOptions.SaveDataType

Clase PdfToJpegOptions

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← PdfToJpegOptions

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

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

int

PageList

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

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

Valor de la propiedad

List<int&gt;

Quality

Obtiene y establece la calidad de salida.

public int Quality { get; set; }

Valor de la propiedad

int

Clase PdfToPngOptions

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← PdfToPngOptions

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

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

int

PageList

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

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

Valor de la propiedad

List<int&gt;

Clase PdfToTiffOptions

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← PdfToTiffOptions

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

PdfToTiffOptions()

Inicializa una nueva instancia del objeto Documentize.PdfToTiffOptions.

public PdfToTiffOptions()

Propiedades

MultiPage

Obtiene y establece una bandera que permite guardar todas las páginas en un TIFF multipágina.

public bool MultiPage { get; set; }

Valor de la propiedad

bool

OutputResolution

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

public int OutputResolution { get; set; }

Valor de la propiedad

int

PageList

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

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

Valor de la propiedad

List<int&gt;

Clase PdfToXlsOptions

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

Herencia

object ← PdfConverterOptions ← PdfToXlsOptions

Implementa

• IPluginOptions

Miembros heredados

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

Constructores

PdfToXlsOptions()

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

public PdfToXlsOptions()

Propiedades

Formato

Formato de salida.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Valor de la propiedad

PdfToXlsOptions.ExcelFormat

InsertarColumnaEnBlancoAlPrincipio

Establezca en verdadero si necesita insertar una columna en blanco como la primera columna de la hoja de trabajo. El valor predeterminado es falso; lo que significa que la columna en blanco no se insertará.

public bool InsertBlankColumnAtFirst { get; set; }

Valor de la propiedad

bool

MinimizarElNúmeroDeHojasDeCálculo

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

public bool MinimizeTheNumberOfWorksheets { get; set; }

Valor de la propiedad

bool

Clase PluginBaseOptions

public class PluginBaseOptions : IPluginOptions

Herencia

object ← PluginBaseOptions

Derivados

• AddTimestampOptions,
• CompressOptions,
• DecryptionOptions,
• EncryptionOptions,
• HtmlToPdfOptions,
• MergeOptions,
• OptimizeOptions,
• PdfToJpegOptions,
• PdfToPngOptions,
• PdfToTiffOptions,
• ResizeOptions,
• RotateOptions,
• SignOptions,
• SplitOptions,
• TableOptions

Implementa

• IPluginOptions

Miembros heredados

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

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

bool

CloseOutputStreams

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

public bool CloseOutputStreams { get; set; }

Valor de la propiedad

bool

Inputs

Devuelve los datos de Inputs para la operación.

public List<idatasource> Inputs { get; }

Valor de la propiedad

List<IDataSource&gt;

Outputs

Devuelve los datos de Outputs para la operación.

public List<idatasource> Outputs { get; }

Valor de la propiedad

List<IDataSource&gt;

Métodos

AddInput(IDataSource)

Agrega nuevos datos a Inputs.

public void AddInput(IDataSource dataSource)

Parámetros

• dataSource IDataSource: Datos a agregar.

AddOutput(IDataSource)

Agrega nuevos datos a Outputs.

public void AddOutput(IDataSource saveDataSource)

Parámetros

• saveDataSource IDataSource: Datos a agregar. :

Clase PngConverter

public sealed class PngConverter  

Inheritance

object ←
PngConverter

Inherited Members

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

Examples

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

// crear PngConverter  
var plugin = new PngConverter();  
// crear objeto PdfToPngOptions para establecer instrucciones  
var opt = new PdfToPngOptions();  
// agregar ruta del archivo de entrada  
opt.AddInput(new FileDataSource(inputPath));  
// establecer ruta del archivo de salida  
opt.AddOutput(new DirectoryDataSource(outputPath));  
// realizar el proceso  
plugin.Process(opt);  

Constructors

PngConverter()

public PngConverter()  

Methods

Process(PdfToPngOptions)

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

public ResultContainer Process(PdfToPngOptions options)  

Parameters

• options PdfToPngOptions: Un objeto de opciones que contiene instrucciones para el Documentize.PngConverter.

Returns

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

Clase Rectángulo

public class Rectangle

Herencia

object ← Rectangle

Miembros heredados

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

Constructores

Rectangle(double, double, double, double)

Constructor de Rectángulo.

public Rectangle(double llx, double lly, double urx, double ury)

Parámetros

• llx double: X de la esquina inferior izquierda.
• lly double: Y de la esquina inferior izquierda.
• urx double: X de la esquina superior derecha.
• ury double: Y de la esquina superior derecha.

Clase RotateOptions

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Herencia

object ← PluginBaseOptions ← RotateOptions

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

RotateOptions()

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

public RotateOptions()

Propiedades

Rotation

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

public Rotation Rotation { get; set; }

Valor de la propiedad

Rotation

Clase StreamDataSource

public sealed class StreamDataSource : IDataSource

Herencia

object ← StreamDataSource

Implementa

• IDataSource

Miembros heredados

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

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 propiedad

Stream

DataType

Tipo de fuente de datos (flujo).

public DataType DataType { get; }

Valor de propiedad

DataType

Clase StringResult

public sealed class StringResult : IOperationResult

Herencia

object ← StringResult

Implementa

• IOperationResult

Miembros heredados

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

Propiedades

Data

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

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.

ToString()

Intenta convertir el resultado a una cadena.

public override string ToString()

Retorna

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

Clase TextExtractorOptions

public sealed class TextExtractorOptions : PdfExtractorOptions, IPluginOptions

Herencia

object ← PdfExtractorOptions ← TextExtractorOptions

Implementa

• IPluginOptions

Miembros heredados

• PdfExtractorOptions.AddInput(IDataSource),
• PdfExtractorOptions.Inputs,
• PdfExtractorOptions.OperationName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Ejemplos

El ejemplo demuestra cómo extraer el contenido textual del documento PDF.

// crear objeto TextExtractor para extraer contenidos PDF
using (TextExtractor extractor = new TextExtractor())
{
    // crear objeto TextExtractorOptions para establecer TextFormattingMode (Puro, o Crudo - predeterminado)
    extractorOptions = new TextExtractorOptions(TextExtractorOptions.TextFormattingMode.Pure);

    // agregar la ruta del archivo de entrada a las fuentes de datos
    extractorOptions.AddInput(new FileDataSource(inputPath));

    // realizar el proceso de extracción
    ResultContainer resultContainer = extractor.Process(extractorOptions);

    // obtener el texto extraído del objeto ResultContainer
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

Observaciones

El objeto Documentize.TextExtractorOptions se utiliza para establecer Documentize.TextExtractorOptions.TextFormattingMode y otras opciones para la operación de extracción de texto. Además, hereda funciones para agregar datos (archivos, flujos) que representan documentos PDF de entrada.

Constructores

TextExtractorOptions(TextFormattingMode)

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

public TextExtractorOptions(TextExtractorOptions.TextFormattingMode formattingMode)

Parámetros

• formattingMode TextExtractorOptions.TextFormattingMode: Valor del modo de formato de texto.

TextExtractorOptions()

Inicializa una nueva instancia del objeto Documentize.TextExtractorOptions con el modo de formato de texto ‘Crudo’ (predeterminado).

public TextExtractorOptions()

Propiedades

FormattingMode

Obtiene el modo de formato.

public TextExtractorOptions.TextFormattingMode FormattingMode { get; }

Valor de la propiedad

TextExtractorOptions.TextFormattingMode

OperationName

Devuelve el nombre de la operación.

public override string OperationName { get; }

Valor de la propiedad

string

Clase TiffConverter

public sealed class TiffConverter

Herencia

object ← TiffConverter

Miembros heredados

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

Ejemplos

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

// crear TiffConverter
var plugin = new TiffConverter();
// crear objeto PdfToTiffOptions para establecer instrucciones
var opt = new PdfToTiffOptions();
// añadir la ruta del archivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// establecer la ruta del archivo de salida
opt.AddOutput(new DirectoryDataSource(outputPath));
// realizar el proceso
plugin.Process(opt);

Constructores

TiffConverter()

public TiffConverter()

Métodos

Process(PdfToTiffOptions)

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

public ResultContainer Process(PdfToTiffOptions options)

Parámetros

• options PdfToTiffOptions: Un objeto de opciones que contiene instrucciones para el Documentize.TiffConverter.

Devuelve

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

Clase XlsConverter

public sealed class XlsConverter

Herencia

object ← XlsConverter

Miembros heredados

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

Ejemplos

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

// crear XlsConverter
var plugin = new XlsConverter();
// crear PdfToXlsOptions 
var opt = new PdfToXlsOptions();
// agregar ruta del archivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// establecer ruta del archivo de salida
opt.AddOutput(new FileDataSource(outputPath));
// realizar el proceso
plugin.Process(opt);

Constructores

XlsConverter()

public XlsConverter()

Métodos

Process(PdfToXlsOptions)

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

public ResultContainer Process(PdfToXlsOptions options)

Parámetros

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

Retorna

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

Construcción de Celdas de Tabla

public class TableCellBuilder : TableRowBuilder

Herencia

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

Miembros heredados

• TableRowBuilder.AddCell(),
• TableRowBuilder.AddRow(),
• TableBuilder.AddRow(),
• TableBuilder.AddTable(),
• TableBuilder.InsertPageAfter(int),
• TableBuilder.InsertPageBefore(int),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

AddCell()

Añadir celda a la tabla.

public override TableCellBuilder AddCell()

Devuelve

TableCellBuilder : Instancia de la 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 de la actual Documentize.TableCellBuilder.

Constructor de tabla de clase

public class TableBuilder

Herencia

object ← TableBuilder

Derivados

• TableRowBuilder

Miembros heredados

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

Métodos

AddRow()

Añadir nueva fila a la tabla.

public virtual TableRowBuilder AddRow()

Devuelve

TableRowBuilder : Instancia de la actual Documentize.TableRowBuilder.

AddTable()

Añadir nueva tabla al documento.

public TableBuilder AddTable()

Devuelve

TableBuilder : Instancia de la 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 de la 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 después de la cual insertar la tabla.

Devuelve

TableOptions : Instancia de la 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 de la actual Documentize.TableBuilder.

Devuelve

TableOptions : Resultado de la conversión a PdfGeneratorTableOptions.

Constructor de TableRow

public class TableRowBuilder : TableBuilder

Herencia

object ← TableBuilder ← TableRowBuilder

Derivados

• TableCellBuilder

Miembros heredados

• TableBuilder.AddRow(),
• TableBuilder.AddTable(),
• TableBuilder.InsertPageAfter(int),
• TableBuilder.InsertPageBefore(int),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Métodos

AddCell()

Agregar celda a la fila de la tabla.

public virtual TableCellBuilder AddCell()

Devuelve

TableCellBuilder : Instancia del Documentize.TableCellBuilder creado.

AddRow()

Sobrescribiendo AddRow.

public override TableRowBuilder AddRow()

Devuelve

TableRowBuilder : Instancia del Documentize.TableRowBuilder actual.

Divisor de Clase

public class Splitter

Herencia

object ← Splitter

Miembros heredados

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

Ejemplos

El ejemplo demuestra cómo dividir un documento PDF.

// crear Splitter
var plugin = new Splitter();
// crear objeto SplitOptions para establecer instrucciones
var opt = new SplitOptions();
// agregar ruta del archivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// establecer rutas de los archivos de salida
opt.AddOutput(new FileDataSource(outputPath1));
opt.AddOutput(new FileDataSource(outputPath2));
// realizar el proceso
plugin.Process(opt);

Constructores

Splitter()

public Splitter()

Métodos

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Parámetros

• options IPluginOptions: Un objeto de opciones que contiene instrucciones para Documentize.Splitter.

Retorna

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

Excepciones

InvalidOperationException

Enum ConvertErrorAction

public enum ConvertErrorAction

Campos

• Delete = 0
• None = 1

Enum HtmlMediaType

public enum HtmlMediaType

Campos

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

Enum HtmlPageLayoutOption

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

Enum PdfAStandardVersion

public enum PdfAStandardVersion

Campos

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

Enum PdfToHtmlOptions.SaveDataType

public enum PdfToHtmlOptions.SaveDataType  

Campos

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

Enum PdfToXlsOptions.ExcelFormat

Permite especificar el formato de archivo .xlsx, .xls/xml o csv. El valor predeterminado es XLSX.

public enum PdfToXlsOptions.ExcelFormat

Campos

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

Enum TextExtractorOptions.TextFormattingMode

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.

Extractor de Texto de Clase

public class TextExtractor : PdfExtractor, IDisposable

Herencia

object ← PdfExtractor ← TextExtractor

Implementa

• IDisposable

Miembros heredados

• PdfExtractor.Process(IPluginOptions),
• PdfExtractor.Dispose(),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Ejemplos

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

// crear objeto TextExtractor para extraer texto en contenidos PDF
using (var plugin = new TextExtractor())
{
    // crear TextExtractorOptions
    var opt = new TextExtractorOptions();

    // agregar ruta del archivo de entrada
    opt.AddInput(new FileDataSource(inputPath));

    // realizar el proceso de extracción
    var resultContainer = plugin.Process(opt);

    // obtener el texto extraído del objeto ResultContainer
    var textExtracted = resultContainer.ResultCollection[0].ToString();
}

Constructores

TextExtractor()

public TextExtractor()

Firma de Clase

public sealed class Signature

Herencia

object ← Signature

Miembros heredados

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

Ejemplos

El ejemplo demuestra cómo firmar un documento PDF.

// crear Firma
var plugin = new Signature();
// crear objeto SignOptions para establecer instrucciones
var opt = new SignOptions(inputPfx, inputPfxPassword);
// agregar ruta del archivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// establecer ruta del archivo de salida
opt.AddOutput(new FileDataSource(outputPath));
// realizar el proceso
plugin.Process(opt);

Constructores

Signature()

public Signature()

Métodos

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Parámetros

• options IPluginOptions: Un objeto de opciones que contiene instrucciones para Documentize.Signature.

Retorna

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

Excepciones

InvalidOperationException

Fusión de Clases

public sealed class Merger

Herencia

object ← Merger

Miembros Heredados

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

Ejemplos

El ejemplo demuestra cómo fusionar dos documentos PDF.

// crear Merger
var plugin = new Merger();
// crear objeto MergeOptions para establecer instrucciones
var opt = new MergeOptions();
// añadir rutas de archivos de entrada
opt.AddInput(new FileDataSource(inputPath1));
opt.AddInput(new FileDataSource(inputPath2));
// establecer ruta de archivo de salida
opt.AddOutput(new FileDataSource(outputPath));
// realizar el proceso
plugin.Process(opt);