Class AddTimestampOptions

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← AddTimestampOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

AddTimestampOptions(Stream, string, string, string)

Inicializa uma nova instância do objeto Documentize.AddTimestampOptions com opções padrão.

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

Parâmetros

• pfx Stream: O caminho para o arquivo pfx.
• password string: A senha para o arquivo pfx.
• serverUrl string: A URL do servidor de timestamp.
• serverBasicAuthCredentials string: As credenciais de autenticação básica, nome de usuário e senha são combinados em uma string “username:password”. (Opcional).

AddTimestampOptions(string, string, string, string)

Inicializa uma nova instância do objeto Documentize.AddTimestampOptions com opções padrão.

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

Parâmetros

• pfx string: O caminho para o arquivo pfx.
• password string: A senha para o arquivo pfx.
• serverUrl string: A URL do servidor de timestamp.
• serverBasicAuthCredentials string: As credenciais de autenticação básica, nome de usuário e senha são combinados em uma string “username:password”. (Opcional).

Class CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← CompressOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

CompressOptions()

Inicializa uma nova instância do objeto Documentize.CompressOptions com opções padrão.

public CompressOptions()

Class DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← DecryptionOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

DecryptionOptions(string)

Inicializa uma nova instância do objeto Documentize.DecryptionOptions com opções padrão.

public DecryptionOptions(string ownerPassword)

Parâmetros

• ownerPassword string: Senha do proprietário.

Propriedades

OwnerPassword

Senha do proprietário.

public string OwnerPassword { get; set; }

Valor da Propriedade

string

Class DirectoryDataSource

public sealed class DirectoryDataSource : IDataSource

Herança

object ← DirectoryDataSource

Implementa

• IDataSource

Membros Herdados

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

Construtores

DirectoryDataSource(string)

Inicializa novos dados de diretório com o caminho especificado.

public DirectoryDataSource(string path)

Parâmetros

• path string: Uma string representando o caminho para o diretório.

Propriedades

DataType

Tipo de fonte de dados.

public DataType DataType { get; }

Valor da Propriedade

DataType

Path

Obtém o caminho para o diretório dos dados atuais.

public string Path { get; }

Valor da Propriedade

string

Class DocConverter

public static class DocConverter

Herança

object ← DocConverter

Membros Herdados

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

Exemplos

O exemplo demonstra como converter documento PDF para o formato Doc.

// Cria um objeto PdfToDocOptions para definir as instruções
var options = new PdfToDocOptions();
// Adiciona o caminho do arquivo de entrada
options.AddInput(new FileDataSource("caminho_para_seu_arquivo_pdf.pdf"));
// Define o caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_resultante.doc"));
// Realiza o processo
DocConverter.Process(options);

O exemplo demonstra como converter documento PDF para o formato Doc definindo o Modo.

// Cria um objeto PdfToDocOptions para definir as instruções
var options = new PdfToDocOptions();
// Adiciona o caminho do arquivo de entrada
options.AddInput(new FileDataSource("caminho_para_seu_arquivo_pdf.pdf"));
// Define o caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_resultante.doc"));
// Define o Modo
options.Mode = DocConversionMode.Flow;
// Realiza o processo
DocConverter.Process(options);

Métodos

Process(PdfToDocOptions)

Converte documento PDF em formato DOC/DOCX.

public static ResultContainer Process(PdfToDocOptions options)

Parâmetros

• options PdfToDocOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não forem definidas.

Class EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← EncryptionOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

EncryptionOptions(string, string)

Inicializa uma nova instância do objeto Documentize.EncryptionOptions com opções padrão.

public EncryptionOptions(string ownerPassword, string userPassword)

Parâmetros

• ownerPassword string: Senha do proprietário.
• userPassword string: Senha do usuário.

Propriedades

OwnerPassword

Senha do proprietário.

public string OwnerPassword { get; set; }

Valor da Propriedade

string

UserPassword

Senha do usuário.

public string UserPassword { get; set; }

Valor da Propriedade

string

Class ExtractFormDataToDsvOptions

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

ExtractFormDataToDsvOptions(char, bool)

Inicializa uma nova instância do objeto Documentize.ExtractFormDataToDsvOptions.

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

Parâmetros

• delimeter char: Especifica o delimitador a ser usado nos dados exportados entre os valores. O valor padrão é ‘,’.
• addFieldNames bool: Adiciona o nome do campo antes do valor. Formato: Nome + delimitador + Valor + delimitador.

Propriedades

AddFieldName

Adiciona o nome do campo antes do valor. Formato: Nome + delimitador + Valor + delimitador.

public bool AddFieldName { get; set; }

Valor da Propriedade

bool

Delimeter

Delimitador usado para os valores exportados.

public char Delimeter { get; set; }

Valor da Propriedade

char

Class ExtractImagesOptions

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← ExtractImagesOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

ExtractImagesOptions()

Inicializa uma nova instância do objeto Documentize.ExtractImagesOptions com opções padrão.

public ExtractImagesOptions()

Class ExtractTextOptions

public sealed class ExtractTextOptions

Herança

object ← ExtractTextOptions

Membros Herdados

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

Construtores

ExtractTextOptions(TextFormattingMode)

Inicializa uma nova instância do objeto Documentize.ExtractTextOptions para o modo de formatação de texto especificado.

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parâmetros

• formattingMode TextFormattingMode: Valor do modo de formatação de texto.

Propriedades

FormattingMode

Obtém o modo de formatação.

public TextFormattingMode FormattingMode { get; set; }

Valor da Propriedade

TextFormattingMode

Inputs

Retorna dados de Inputs para a operação.

public List<idatasource> Inputs { get; }

Valor da Propriedade

List<IDataSource>

Métodos

AddInput(IDataSource)

Adiciona novos dados a Inputs.

public void AddInput(IDataSource dataSource)

Parâmetros

• dataSource IDataSource: Fonte de dados a ser adicionada. :

Class FileDataSource

public sealed class FileDataSource : IDataSource

Herança

object ← FileDataSource

Implementa

• IDataSource

Membros Herdados

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

Construtores

FileDataSource(string)

Inicializa uma nova fonte de dados de arquivo com o caminho especificado.

public FileDataSource(string path)

Parâmetros

• path string: Uma string representando o caminho para o arquivo de origem.

Propriedades

DataType

Tipo da fonte de dados.

public DataType DataType { get; }

Valor da Propriedade

DataType

Path

Obtém o caminho para o arquivo dos dados atuais.

public string Path { get; }

Valor da Propriedade

string

Class FileResult

public sealed class FileResult : IOperationResult

Herança

object ← FileResult

Implementa

• IOperationResult

Membros Herdados

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

Propriedades

Data

Obtém os dados brutos.

public object Data { get; }

Valor da Propriedade

object

IsFile

Indica se o resultado é um caminho para um arquivo de saída.

public bool IsFile { get; }

Valor da Propriedade

bool

IsStream

Indica se o resultado é um fluxo de saída.

public bool IsStream { get; }

Valor da Propriedade

bool

IsString

Indica se o resultado é uma string de texto.

public bool IsString { get; }

Valor da Propriedade

bool

Métodos

ToFile()

Tenta converter o resultado para um arquivo.

public string ToFile()

Retorna

string : Uma string representando o caminho para o arquivo de saída se o resultado for um arquivo; caso contrário, null.

ToStream()

Tenta converter o resultado para um objeto de fluxo.

public Stream ToStream()

Retorna

Stream : Um objeto de fluxo representando os dados de saída se o resultado for um fluxo; caso contrário, null.

Class FormExporter

[Obsolete("Por favor, use a classe PdfExtractor. A classe será deletada em breve.")]
public static class FormExporter

Herança

object ← FormExporter

Membros Herdados

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

Métodos

Process(ExtractFormDataToDsvOptions)

Inicia o processamento Documentize.FormExporter com os parâmetros especificados.

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

Parâmetros

• options ExtractFormDataToDsvOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não forem definidas.

Class FormExportToDsvOptions

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← FormExportToDsvOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

FormExportToDsvOptions(char, bool)

Inicializa uma nova instância do objeto Documentize.FormExportToDsvOptions.

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

Parâmetros

• delimeter char: Especifica o delimitador a ser usado nos dados exportados entre os valores. O valor padrão é ‘,’.
• addFieldNames bool: Adiciona o nome do campo antes do valor. Formato: Nome + delimitador + Valor + delimitador.

Propriedades

AddFieldName

Adiciona o nome do campo antes do valor. Formato: Nome + delimitador + Valor + delimitador.

public bool AddFieldName { get; set; }

Valor da Propriedade

bool

Delimeter

Delimitador usado para valores exportados.

public char Delimeter { get; set; }

Valor da Propriedade

char

Class FormFlattener

public static class FormFlattener

Herança

object ← FormFlattener

Membros Herdados

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

Exemplos

O exemplo demonstra como achatar campos em um arquivo PDF.

// Criar objeto FormFlattenerOptions para definir as instruções
var options = new FormFlattenerOptions();
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realizar o processo
FormFlattener.Process(options);

O exemplo demonstra como achatar campos em um arquivo PDF e pular o primeiro campo.

// Obter nomes dos campos
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// Criar objeto FormFlattenerOptions para definir as instruções
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Pular 1 campo.
options.SkipFields.Add(fieldNames[0]);
// Realizar o processo
FormFlattener.Process(options);

O exemplo demonstra como obter os nomes dos campos de um arquivo PDF.

// Obter nomes dos campos
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

Métodos

GetFieldNames(string)

Obter nomes dos campos no documento PDF.

public static List<string> GetFieldNames(string path)

Parâmetros

• path string: O caminho para o documento PDF.

Retorna

List<string>

Lista de nomes no documento PDF.

GetFieldNames(Stream) : Obter nomes dos campos no documento PDF.

public static List<string> GetFieldNames(Stream stream)

Parâmetros

• stream Stream: O stream com o documento PDF.

Retorna

List<string>

Lista de nomes no documento PDF.

Process(FormFlattenerOptions) : Achatar campos de formulário no documento PDF.

public static ResultContainer Process(FormFlattenerOptions options)

Parâmetros

• options FormFlattenerOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não estiverem definidas.

Class FormFlattenerOptions

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← FormFlattenerOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

FormFlattenerOptions()

Inicializa uma nova instância do objeto Documentize.FormFlattenerOptions com opções padrão.

public FormFlattenerOptions()

Propriedades

SkipFields

A lista de campos que não serão achatados.

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

Valor da Propriedade

List<string>

Class HtmlConverter

public static class HtmlConverter

Herança

object ← HtmlConverter

Membros Herdados

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

Exemplos

O exemplo demonstra como converter PDF para documento HTML.

// Criar objeto PdfToHtmlOptions para definir o tipo de dado de saída como arquivo com recursos incorporados
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_output.html"));
// Realizar o processo
HtmlConverter.Process(options);

O exemplo demonstra como converter HTML para documento PDF.

// Criar HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.html"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Realizar o processo
HtmlConverter.Process(options);

Métodos

Process(PdfToHtmlOptions)

Converte documentos PDF em formato HTML.

public static ResultContainer Process(PdfToHtmlOptions options)

Parâmetros

• options PdfToHtmlOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não estiverem definidas.

Process(HtmlToPdfOptions)

Converte documentos HTML em formato PDF.

public static ResultContainer Process(HtmlToPdfOptions options)

Parâmetros

• options HtmlToPdfOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não estiverem definidas.

Class HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← HtmlToPdfOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

HtmlToPdfOptions()

Inicializa uma nova instância do objeto Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Propriedades

BasePath

O caminho/url base para o arquivo html.

public string BasePath { get; set; }

Valor da Propriedade

string

HtmlMediaType

Obtém ou define os tipos de mídia possíveis usados durante a renderização.

public HtmlMediaType HtmlMediaType { get; set; }

Valor da Propriedade

HtmlMediaType

IsRenderToSinglePage

Obtém ou define a renderização de todo o documento em uma única página.

public bool IsRenderToSinglePage { get; set; }

Valor da Propriedade

bool

PageInfo

Obtém ou define informações da página do documento.

public PageInfo PageInfo { get; set; }

Valor da Propriedade

PageInfo

PageLayoutOption

Obtém ou define a opção de layout.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Valor da Propriedade

HtmlPageLayoutOption

Class ImageExtractor

[Obsolete("Por favor, use a classe PdfExtractor. A classe será deletada em breve.")]
public static class ImageExtractor

Herança

object ← ImageExtractor

Membros Herdados

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

Métodos

Process(ExtractImagesOptions)

Extrai imagens de documento PDF.

public static ResultContainer Process(ExtractImagesOptions options)

Parâmetros

• options ExtractImagesOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não forem definidas.

Class ImageExtractorOptions

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← ImageExtractorOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

ImageExtractorOptions()

Inicializa uma nova instância do objeto Documentize.ImageExtractorOptions com opções padrão.

public ImageExtractorOptions()

Class JpegConverter

public static class JpegConverter

Herança

object ← JpegConverter

Membros Herdados

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

Exemplos

O exemplo demonstra como converter um documento PDF em formato JPEG.

// Cria um objeto PdfToJpegOptions para definir instruções
var options = new PdfToJpegOptions();
// Adiciona o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Define o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Realiza o processo
JpegConverter.Process(options);

O exemplo demonstra como converter um documento PDF em formato JPEG com configurações para páginas, resolução e qualidade.

// Cria um objeto PdfToJpegOptions para definir instruções
var options = new PdfToJpegOptions();
// Processa apenas a primeira página
options.PageList = [1];
// Define a resolução de saída para 200 DPI
options.OutputResolution = 200;
// Define a qualidade de saída para 50
options.Quality = 50;
// Adiciona o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Define o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Realiza o processo
JpegConverter.Process(options);

O exemplo demonstra como converter um documento PDF em formato JPEG para streams.

// Cria um objeto PdfToJpegOptions para definir instruções
var options = new PdfToJpegOptions();
// Adiciona o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Realiza o processo
var results = JpegConverter.Process(options);
// Obtém os resultados em stream
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Métodos

Process(PdfToJpegOptions)

Converte um documento PDF em formato JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Parâmetros

• options PdfToJpegOptions: Um objeto de opções contendo instruções para o Documentize.JpegConverter.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não forem configuradas.

Class License

public static class License

Herança

object ← License

Membros Herdados

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

Exemplos

Mostra como ativar uma licença.

// Definir Licença
License.Set("PathToLicense.lic");

Métodos

Set(string)

Licencia o componente.

public static void Set(string licenseName)

Parâmetros

• licenseName string: Pode ser um nome de arquivo completo ou curto. Use uma string vazia para mudar para o modo de avaliação.

Class MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← MergeOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

MergeOptions()

Inicializa uma nova instância do objeto Documentize.MergeOptions com opções padrão.

public MergeOptions()

Class Merger

[Obsolete("Por favor, use a classe PdfManager. A classe será removida em breve.")]
public static class Merger

Herança

object ← Merger

Membros Herdados

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

Métodos

Process(MergeOptions)

Mescla documentos PDF.

public static ResultContainer Process(MergeOptions options)

Parâmetros

• options MergeOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não estiverem definidas.

Class Message

public class Message

Herança

object ← Message

Membros Herdados

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

Construtores

Message()

public Message()

Propriedades

Conteúdo

O conteúdo da mensagem.

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

Valor da Propriedade

string

Papel

Define ou obtém o papel do autor desta mensagem.

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

Valor da Propriedade

Role

Class ObjectResult

public sealed class ObjectResult : IOperationResult

Herança

object ← ObjectResult

Implementa

• IOperationResult

Membros Herdados

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

Propriedades

Data

Obtém dados brutos.

public object Data { get; }

Valor da Propriedade

object

IsFile

Indica se o resultado é um caminho para um arquivo de saída.

public bool IsFile { get; }

Valor da Propriedade

bool

IsObject

Indica se o resultado é um objeto.

public bool IsObject { get; }

Valor da Propriedade

bool

IsStream

Indica se o resultado é um caminho para um arquivo de saída.

public bool IsStream { get; }

Valor da Propriedade

bool

IsString

Indica se o resultado é uma string.

public bool IsString { get; }

Valor da Propriedade

bool

Text

Retorna a representação em string do resultado.

public string Text { get; }

Valor da Propriedade

string

Métodos

ToFile()

Tenta converter o resultado em um arquivo.

public string ToFile()

Retornos

string : Uma string representando o caminho para o arquivo de saída se o resultado for um arquivo; caso contrário, null.

ToStream()

Tenta converter o resultado em um objeto de stream.

public Stream ToStream()

Retornos

Stream : Um objeto de stream representando os dados de saída se o resultado for um stream; caso contrário, null.

ToString()

Tenta converter o resultado em uma string.

public override string ToString()

Retornos

string : Uma string representando o conteúdo de texto se o resultado for uma string; caso contrário, retorna base.ToString().

Class OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← OptimizeOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

OptimizeOptions()

Inicializa uma nova instância do objeto Documentize.OptimizeOptions com opções padrão. Linearize o documento para

• abrir a primeira página o mais rápido possível;
• exibir a próxima página ou seguir por link para a próxima página o mais rápido possível;
• exibir a página incrementalmente à medida que chega, quando os dados para uma página são entregues por um canal lento (exibir os dados mais úteis primeiro);
• permitir interação do usuário, como seguir um link, a ser realizada mesmo antes que a página inteira tenha sido recebida e exibida.

public OptimizeOptions()

Class Optimizer

[Obsolete("Por favor, use a classe PdfManager. A classe será deletada em breve.")]
public static class Optimizer

Herança

object ← Optimizer

Membros Herdados

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

Métodos

Process(OptimizeOptions)

Inicia o processamento do Documentize.Optimizer com os parâmetros especificados.

public static ResultContainer Process(OptimizeOptions options)

Parâmetros

• options OptimizeOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Process(RotateOptions)

Inicia o processamento do Documentize.Optimizer com os parâmetros especificados.

public static ResultContainer Process(RotateOptions options)

Parâmetros

• options RotateOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Process(ResizeOptions)

Inicia o processamento do Documentize.Optimizer com os parâmetros especificados.

public static ResultContainer Process(ResizeOptions options)

Parâmetros

• options ResizeOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Process(CompressOptions)

Inicia o processamento do Documentize.Optimizer com os parâmetros especificados.

public static ResultContainer Process(CompressOptions options)

Parâmetros

• options CompressOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Class PageInfo

public class PageInfo : PageSize

Herança

object ← PageSize ← PageInfo

Membros Herdados

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

Construtores

PageInfo()

Construtor de Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Construtor de Documentize.PageInfo.

public PageInfo(double width, double height)

Parâmetros

• width double: Largura da página.
• height double: Altura da página.

Propriedades

MarginBottom

Obtém ou define um valor que indica a margem inferior.

public double MarginBottom { get; set; }

Valor da Propriedade

double

MarginLeft

Obtém ou define um valor que indica a margem esquerda.

public double MarginLeft { get; set; }

Valor da Propriedade

double

MarginRight

Obtém ou define um valor que indica a margem direita.

public double MarginRight { get; set; }

Valor da Propriedade

double

MarginTop

Obtém ou define um valor que indica a margem superior.

public double MarginTop { get; set; }

Valor da Propriedade

double

Class PageSize

public class PageSize

Herança

object ← PageSize

Derivados

• PageInfo

Membros Herdados

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

Construtores

PageSize()

Construtor de Documentize.PageSize. Tamanhos A4 por padrão.

public PageSize()

PageSize(double, double)

Construtor de Documentize.PageSize.

public PageSize(double width, double height)

Parâmetros

• width double: Largura da página.
• height double: Altura da página.

Propriedades

A0

Tamanho A0 (1189x840 mm).

public static PageSize A0 { get; }

Valor da Propriedade

PageSize

A1

Tamanho A1 (840x594 mm).

public static PageSize A1 { get; }

Valor da Propriedade

PageSize

A2

Tamanho A2 (594x420 mm).

public static PageSize A2 { get; }

Valor da Propriedade

PageSize

A3

Tamanho A3 (420x297 mm).

public static PageSize A3 { get; }

Valor da Propriedade

PageSize

A4

Tamanho A4 (297x210 mm).

public static PageSize A4 { get; }

Valor da Propriedade

PageSize

A5

Tamanho A5 (210x148 mm).

public static PageSize A5 { get; }

Valor da Propriedade

PageSize

A6

Tamanho A6 (148x105 mm).

public static PageSize A6 { get; }

Valor da Propriedade

PageSize

B5

Tamanho B5 (250x176 mm).

public static PageSize B5 { get; }

Valor da Propriedade

PageSize

Height

Obtém ou define a altura da página.

public double Height { get; set; }

Valor da Propriedade

double

IsLandscape

Obtém a orientação da página. Retorna verdadeiro se esta for a orientação paisagem e falso se for retrato.

public bool IsLandscape { get; }

Valor da Propriedade

bool

P11x17

Formato 11x17 polegadas.

public static PageSize P11x17 { get; }

Valor da Propriedade

PageSize

PageLedger

Tamanho Ledger (432x279 mm).

public static PageSize PageLedger { get; }

Valor da Propriedade

PageSize

PageLegal

Tamanho Legal (356x216 mm).

public static PageSize PageLegal { get; }

Valor da Propriedade

PageSize

PageLetter

Tamanho Carta (279x216 mm).

public static PageSize PageLetter { get; }

Valor da Propriedade

PageSize

Width

Obtém ou define a largura da página.

public double Width { get; set; }

Valor da Propriedade

double

Class PdfAConverter

public static class PdfAConverter

Herança

object ← PdfAConverter

Membros Herdados

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

Exemplos

O exemplo demonstra como converter o documento PDF em um formato PDF/A (PDF/A-3b neste caso):

// Crie a classe de opções para configurar o processo de conversão
var options = new PdfAConvertOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Adicione o arquivo fonte
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // substitua pelo caminho real do seu arquivo

// Adicione o caminho para salvar o arquivo convertido
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));

// Execute a conversão
PdfAConverter.Process(options);

O exemplo demonstra como validar a conformidade do documento PDF com o formato PDF/A (PDF/A-1a neste caso):

// Crie a classe de opções para configurar o processo de validação
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Adicione um ou mais arquivos a serem validados
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // substitua pelo caminho real do seu arquivo
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// adicione mais arquivos conforme necessário

// Execute a validação e obtenha os resultados
var resultContainer = PdfAConverter.Process(options);

// Verifique a propriedade resultContainer.ResultCollection para os resultados de validação para cada arquivo:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Resultado da validação do i-ésimo documento
}

Métodos

Process(PdfAConvertOptions)

Converte documento PDF para o formato PDF/A.

public static ResultContainer Process(PdfAConvertOptions options)

Parâmetros

• options PdfAConvertOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não forem definidas.

Process(PdfAValidateOptions)

Verifica o documento PDF quanto à conformidade com o formato especificado PDF/A.

public static ResultContainer Process(PdfAValidateOptions options)

Parâmetros

• options PdfAValidateOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não forem definidas.

Class PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Herança

object ← PdfAOptionsBase ← PdfAConvertOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfAConvertOptions()

public PdfAConvertOptions()

Propriedades

Outputs

Obtém a coleção de alvos adicionados (fontes de dados de arquivo ou stream) para os resultados da operação de salvamento.

public List<idatasource> Outputs { get; }

Valor da Propriedade

List<IDataSource>

Métodos

AddOutput(IDataSource)

Adiciona um novo alvo de salvamento de resultado.

public void AddOutput(IDataSource dataSource)

Parâmetros

• dataSource IDataSource: Alvo (fonte de dados de arquivo ou stream) para salvar os resultados da operação. :

Class PdfAOptionsBase

Representa a classe base para as opções do plugin Documentize.PdfAConverter. Esta classe fornece propriedades e métodos para configurar o processo de conversão e validação de PDF/A.

public abstract class PdfAOptionsBase : IPluginOptions

Herança

object ← PdfAOptionsBase

Derivados

• PdfAConvertOptions,
• PdfAValidateOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfAOptionsBase()

protected PdfAOptionsBase()

Propriedades

AlignText

Obtém ou define um valor que indica se meios adicionais são necessários para preservar o alinhamento do texto durante o processo de conversão de PDF/A.

public bool AlignText { get; set; }

Valor da Propriedade

bool

Observações

Quando definido como true, o processo de conversão tentará restaurar os limites do segmento de texto original. Para a maioria dos documentos, não há necessidade de mudar essa propriedade do valor padrão false, já que o alinhamento do texto não muda durante o processo de conversão padrão.

CheckDifferentNamesInFontDictionaries

Obtém as flags que controlam a conversão de PDF/A para casos em que o documento PDF de origem não corresponde à especificação PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Valor da Propriedade

bool

ErrorAction

Obtém ou define a ação a ser tomada para objetos que não podem ser convertidos.

public ConvertErrorAction ErrorAction { get; set; }

Valor da Propriedade

ConvertErrorAction

IccProfileFileName

Obtém ou define o nome do arquivo do perfil ICC (International Color Consortium) a ser usado para a conversão de PDF/A no lugar do padrão.

public string IccProfileFileName { get; set; }

Valor da Propriedade

string

Inputs

Obtém a coleção de fontes de dados

public List<idatasource> Inputs { get; }

Valor da Propriedade

List<IDataSource>

IsLowMemoryMode

Obtém ou define um valor que indica se o modo de baixa memória está habilitado durante o processo de conversão de PDF/A.

public bool IsLowMemoryMode { get; set; }

Valor da Propriedade

bool

LogOutputSource

Obtém ou define a fonte de dados para a saída do log.

public IDataSource LogOutputSource { get; set; }

Valor da Propriedade

IDataSource

OptimizeFileSize

Obtém ou define um valor que indica se deve tentar reduzir o tamanho do arquivo durante o processo de conversão de PDF/A.

public bool OptimizeFileSize { get; set; }

Valor da Propriedade

bool

Observações

Quando definido como true, o processo de conversão tentará minimizar o tamanho do arquivo resultante. Isso pode afetar o desempenho do processo de conversão.

PdfAVersion

Obtém ou define a versão do padrão PDF/A a ser usada para validação ou conversão.

public PdfAStandardVersion PdfAVersion { get; set; }

Valor da Propriedade

PdfAStandardVersion

Observações

A versão do padrão PDF/A é usada para determinar o nível de conformidade para a validação e conversão de PDF/A. Se a versão for definida como Documentize.PdfAStandardVersion.Auto, o sistema determinará automaticamente a versão apropriada do padrão PDF/A para validação com base nos metadados do documento. Para o processo de conversão de PDF/A, o Documentize.PdfAStandardVersion.Auto padrão é a versão do padrão PDF/A-1b.

SoftMaskAction

Obtém ou define a ação a ser tomada durante a conversão de imagens com máscaras suaves.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Valor da Propriedade

ConvertSoftMaskAction

Métodos

AddInput(IDataSource)

Adiciona uma nova fonte de dados à coleção

public void AddInput(IDataSource dataSource)

Parâmetros

• dataSource IDataSource:

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Herança

object ← PdfAOptionsBase ← PdfAValidateOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfAValidateOptions()

public PdfAValidateOptions()

Class PdfAValidationResult

public sealed class PdfAValidationResult

Herança

object ← PdfAValidationResult

Membros Herdados

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

Campos

• DataSource Obtém a fonte de dados que foi validada.

Valor do Campo

IDataSource

IsValid

Obtém um valor que indica se a validação foi bem-sucedida.

public readonly bool IsValid

Valor do Campo

bool

StandardVersion

Obtém a versão do padrão PDF/A utilizada para validação.

public readonly PdfAStandardVersion StandardVersion

Valor do Campo

PdfAStandardVersion

Class PdfChatGpt

public static class PdfChatGpt

Herança

object ← PdfChatGpt

Membros Herdados

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

Exemplos

O exemplo demonstra como usar o plugin PdfChatGpt adicionando mensagens à requisição.

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Adiciona o caminho do arquivo de saída.
options.ApiKey = "Sua chave de API."; // Você precisa fornecer a chave para acessar a API.
options.MaxTokens = 1000; // O número máximo de tokens a serem gerados na conclusão do chat.

// Adiciona as mensagens da requisição.
options.Messages.Add(new Message
{
    Content = "Você é um assistente útil.",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "Qual é o maior diâmetro de pizza já feito?",
    Role = Role.User
});

// Processa a requisição.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // O objeto de conclusão de chat da API ChatGPT.

O exemplo demonstra como usar o plugin PdfChatGpt adicionando uma mensagem à requisição.

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Adiciona o caminho do arquivo de saída.
options.ApiKey = "Sua chave de API."; // Você precisa fornecer a chave para acessar a API.
options.MaxTokens = 1000; // O número máximo de tokens a serem gerados na conclusão do chat.

// Adiciona a mensagem da requisição.
// Neste caso, a mensagem do sistema com Content = "Você é um assistente útil." é adicionada por padrão.
// O papel da mensagem de consulta é "usuário" por padrão.
options.Query = "Qual é a menor temperatura já registrada na Terra?";

// Processa a requisição.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // O objeto de conclusão de chat da API ChatGPT.

O exemplo demonstra como usar o plugin PdfChatGpt adicionando arquivo(s) como fonte(s) da mensagem.

var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Adiciona o caminho do arquivo de saída.

// Adiciona a fonte de texto do PDF.
// No caso de múltiplas fontes, o texto de cada documento será adicionado à coleção de mensagens da requisição
// como uma mensagem separada com o papel "usuário".
options.AddInput(new FileDataSource("TextSource.pdf"));

options.ApiKey = "Sua chave de API."; // Você precisa fornecer a chave para acessar a API.
options.MaxTokens = 1000; // O número máximo de tokens a serem gerados na conclusão do chat.

// Adiciona a mensagem da requisição.
// Neste caso, a mensagem do sistema com Content = "Você é um assistente útil." é adicionada por padrão.
// O papel da mensagem de consulta é "usuário" por padrão.
options.Query = "Quantas letras há no texto fornecido?";

// Processa a requisição.
var result = await PdfChatGpt.ProcessAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // O objeto de conclusão de chat da API ChatGPT.

Observações

O Documentize.PdfChatGpt é usado para enviar requisições ao ChatGPT diretamente ou adicionando fontes de arquivos PDF e salvando a resposta na fonte de saída.

Métodos

Process(IPluginOptions)

O método não possui versão síncrona. Use o método ProcessAsync em vez disso.

public static ResultContainer Process(IPluginOptions options)

Parâmetros

• options IPluginOptions: Um objeto de opções contendo instruções para o PdfChatGpt.

Retorna

ResultContainer : #### Exceções

NotImplementedException

ProcessAsync(IPluginOptions)

Inicia o processamento do PdfChatGpt com os parâmetros especificados.

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

Parâmetros

• options IPluginOptions: Um objeto de opções contendo instruções para o PdfChatGpt.

Retorna

Task<ResultContainer>

O objeto da tarefa representando a operação assíncrona.

Exceções

ArgumentException : InvalidOperationException

Class PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Herança

object ← PdfChatGptOptions

Derivado

• PdfChatGptRequestOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfChatGptOptions()

Inicializa uma nova instância do objeto Documentize.PdfChatGptOptions.

public PdfChatGptOptions()

Propriedades

Inputs

public List<idatasource> Inputs { get; }

Valor da Propriedade

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

Valor da Propriedade

List<IDataSource>

Métodos

AddInput(IDataSource)

Adiciona uma nova fonte de dados à coleção de dados do plugin PdfChatGpt.

public void AddInput(IDataSource dataSource)

Parâmetros

• dataSource IDataSource: Fonte de dados (arquivo ou stream) a ser adicionada.

AddOutput(IDataSource)

Adiciona uma nova fonte de dados de salvamento à coleção de dados do plugin PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

Parâmetros

• saveDataSource IDataSource: Fonte de dados (arquivo ou stream) para salvar os resultados da operação. :

Class PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Herança

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfChatGptRequestOptions()

Inicializa uma nova instância do objeto Documentize.PdfChatGptRequestOptions com opções padrão.

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

Inicializa uma nova instância do objeto Documentize.PdfChatGptRequestOptions com opções.

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

Parâmetros

• apiKey string: A chave para acessar a API do ChatGPT.
• model string: O nome do modelo do ChatGPT. O modelo padrão é: gpt-3.5-turbo-1106:
• apiUrl string: A URL da API do ChatGPT. A URL padrão é: https://api.openai.com/v1/chat/completions.
• query string: A string de solicitação para o ChatGPT.

Propriedades

ApiKey

Obtém ou define a chave para acessar a API do ChatGPT.

public string ApiKey { get; set; }

Valor da Propriedade

string

ApiUrl

Obtém ou define a URL da API do ChatGPT.

public string ApiUrl { get; set; }

Valor da Propriedade

string

CancellationToken

O token de cancelamento.

public CancellationToken CancellationToken { get; set; }

Valor da Propriedade

CancellationToken

MaxTokens

Número máximo de tokens na resposta. O valor padrão é null, o que significa infinito.

public int? MaxTokens { get; set; }

Valor da Propriedade

int?

Messages

Obtém ou define uma coleção dos objetos Documentize.Message.

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

Valor da Propriedade

List<Message>

Observações

Ao adicionar várias mensagens às opções, a ordem na coleção de mensagens é a seguinte:

• A primeira mensagem (se houver) vem da options.Query, precedida pela mensagem com o conteúdo: “Você é um assistente útil.”, e o papel é “sistema”.
• Em seguida (se houver), as mensagens da coleção options.Messages são adicionadas.
• Mensagens de fontes de arquivo (se houver) são adicionadas por último, um objeto de mensagem para cada documento com o papel “usuário”. Se nenhuma mensagem for fornecida, será lançada uma ArgumentException.

Model

Define ou obtém o ID do modelo a ser utilizado.

public string Model { get; set; }

Valor da Propriedade

string

NumberOfChoices

Quantas opções de conclusão de chat gerar para cada mensagem de entrada.

public int NumberOfChoices { get; set; }

Valor da Propriedade

int

Query

Obtém ou define a string de solicitação para o ChatGPT. Se não estiver vazia, esta é a primeira mensagem na coleção, que será enviada na solicitação.

public string Query { get; set; }

Valor da Propriedade

string

Temperature

Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0.8 tornarão a saída mais aleatória, enquanto valores mais baixos como 0.2 a tornarão mais focada e determinística. O valor padrão é 1.

public double Temperature { get; set; }

Valor da Propriedade

double

Class PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions

Herança

object ← PdfConverterOptions

Derivados

• PdfToXlsOptions

Implementa

• IPluginOptions

Membros Herdados

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

Propriedades

Entradas

Retorna a coleção de dados do plugin PdfConverterOptions.

public List<idatasource> Inputs { get; }

Valor da Propriedade

List<IDataSource>

Saídas

Obtém a coleção de alvos adicionados para os resultados da operação de salvamento.

public List<idatasource> Outputs { get; }

Valor da Propriedade

List<IDataSource>

Métodos

AddInput(IDataSource)

Adiciona uma nova fonte de dados à coleção de dados do plugin PdfConverter.

public void AddInput(IDataSource dataSource)

Parâmetros

• dataSource IDataSource: Fonte de dados a ser adicionada.

AddOutput(IDataSource)

Adiciona uma nova fonte de dados à coleção de dados do plugin PdfToXLSXConverterOptions.

public void AddOutput(IDataSource saveDataSource)

Parâmetros

• saveDataSource IDataSource: Fonte de dados (arquivo ou stream) para os resultados da operação de salvamento.

Exceções

NotImplementedException

Class PdfExtractor

public static class PdfExtractor

Herança

object ← PdfExtractor

Membros Herdados

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

Exemplos

O exemplo demonstra como extrair o conteúdo de texto de um documento PDF.

// Criar objeto ExtractTextOptions para definir instruções
var options = new ExtractTextOptions();
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Realizar o processo
var results = PdfExtractor.ExtractText(options);
// Obter o texto extraído do objeto ResultContainer
var textExtracted = results.ResultCollection[0].ToString();

O exemplo demonstra como extrair o conteúdo de texto de um documento PDF com TextFormattingMode.

// Criar objeto ExtractTextOptions para definir TextFormattingMode
var options = new ExtractTextOptions(TextFormattingMode.Pure);
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Realizar o processo
var results = PdfExtractor.ExtractText(options);
// Obter o texto extraído do objeto ResultContainer
var textExtracted = results.ResultCollection[0].ToString();

O exemplo demonstra como extrair imagens de um documento PDF.

// Criar ExtractImagesOptions para definir instruções
var options = new ExtractImagesOptions();
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// Realizar o processo
var results = PdfExtractor.ExtractImages(options);
// Obter caminho da imagem resultante
var imageExtracted = results.ResultCollection[0].ToFile();

O exemplo demonstra como extrair imagens de um documento PDF para Streams sem pasta.

// Criar ExtractImagesOptions para definir instruções
var options = new ExtractImagesOptions();
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Não definir saída - os resultados serão gravados em streams
// Realizar o processo
var results = PdfExtractor.ExtractImages(options);
// Obter Stream
var ms = results.ResultCollection[0].ToStream();
// Copiar dados para arquivo para demonstração
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

O exemplo demonstra como exportar valores de formulários para um arquivo CSV.

// Criar objeto ExtractFormDataToDsvOptions para definir instruções
var options = new ExtractFormDataToDsvOptions(',', true);
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// Realizar o processo
PdfExtractor.ExtractFormData(options);

Métodos

ExtractFormData(ExtractFormDataToDsvOptions)

Extrai dados de formulário de um documento PDF.

public static ResultContainer ExtractFormData(ExtractFormDataToDsvOptions options)

Parâmetros

• options ExtractFormDataToDsvOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não estiverem definidas.

ExtractImages(ExtractImagesOptions)

Extrai imagens de um documento PDF.

public static ResultContainer ExtractImages(ExtractImagesOptions options)

Parâmetros

• options ExtractImagesOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da operação.

Exceções

ArgumentException

Se as opções não estiverem definidas.

ExtractText(ExtractTextOptions)

Extrai texto de um documento PDF.

public static ResultContainer ExtractText(ExtractTextOptions options)

Parâmetros

• options ExtractTextOptions: Um objeto de opções contendo instruções para a operação.

Retorna

ResultContainer : Um objeto contendo o resultado da extração.

Exceções

ArgumentException

Se as opções não estiverem definidas.

Class PdfManager

Representa o plugin Documentize.PdfManager. Usado para Mesclar, Dividir, Otimizar, Rotacionar, Redimensionar, Compactar documentos PDF e Adicionar Tabela, Adicionar TOC aos documentos PDF. Pode mesclar vários documentos PDF em um único PDF. Pode dividir documentos PDF em páginas separadas. Pode otimizar, rotacionar, redimensionar, compactar documentos PDF. Pode rotacionar, redimensionar páginas do documento PDF. Pode adicionar uma tabela a um documento PDF. Pode adicionar uma tabela de conteúdos a documentos PDF.

public static class PdfManager

Herança

object ← PdfManager

Membros Herdados

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

Exemplos

O exemplo demonstra como Mesclar dois documentos PDF.

// Criar objeto MergeOptions para definir instruções
var options = new MergeOptions();
// Adicionar caminhos dos arquivos de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileDataSource("path_to_your_pdf_file_2.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Executar o processo
PdfManager.Merge(options);

O exemplo demonstra como Dividir um documento PDF.

// Criar objeto SplitOptions para definir instruções
var options = new SplitOptions();
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminhos dos arquivos de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file_2.pdf"));
// Executar o processo
PdfManager.Split(options);

O exemplo demonstra como Otimizar um documento PDF.

// Criar objeto OptimizeOptions para definir instruções
var options = new OptimizeOptions();
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Executar o processo
PdfManager.Optimize(options);

O exemplo demonstra como Rotacionar um documento PDF.

// Criar objeto RotateOptions para definir instruções
var options = new RotateOptions();
// Definir nova Rotação
options.Rotation = Rotation.On90;
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Executar o processo
PdfManager.Rotate(options);

O exemplo demonstra como Redimensionar um documento PDF.

// Criar objeto ResizeOptions para definir instruções
var options = new ResizeOptions();
// Definir novo Tamanho da Página
options.PageSize = PageSize.A3;
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Executar o processo
PdfManager.Resize(options);

O exemplo demonstra como Compactar um documento PDF.

// Criar objeto CompressOptions para definir instruções
var options = new CompressOptions();
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Executar o processo
PdfManager.Compress(options);

O exemplo demonstra como Adicionar Tabela a um arquivo PDF.

// Configurar as opções da tabela
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Nome")
            .AddCell().AddParagraph("Idade")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Executar o processo
PdfManager.AddTable(options);

O exemplo demonstra como adicionar Tabela de Conteúdos a um arquivo PDF.

// Criar objeto TocOptions para definir instruções
var options = new TocOptions();
// Definir o Título
options.Title = "Minha Tabela de Conteúdos";
// Projetar Títulos
options.Headings.Add(new TocHeading("Introdução", 2));
options.Headings.Add(new TocHeading("Capítulo I", 3));
options.Headings.Add(new TocHeading("Capítulo II", 4));
options.Headings.Add(new TocHeading("Capítulo III", 5));
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Executar o processo
PdfManager.AddTableOfContents(options);

O exemplo demonstra como adicionar Tabela de Conteúdos a um arquivo PDF gerando marcadores.

// Criar objeto TocOptions para definir instruções
var options = new TocOptions();
// Definir o Título
options.Title = "Minha Tabela de Conteúdos";
// Gerar links em marcadores
options.GenerateBookmarks = true;
// Projetar Títulos
options.Headings.Add(new TocHeading("Introdução", 2, false, 1));
options.Headings.Add(new TocHeading("Capítulo I", 3, true, 1));
options.Headings.Add(new TocHeading("Capítulo II", 4, true, 1));
options.Headings.Add(new TocHeading("Exemplo A", 4, true, 2));
options.Headings.Add(new TocHeading("Exemplo B", 4, true, 2));
options.Headings.Add(new TocHeading("Exemplo C", 4, true, 2));
options.Headings.Add(new TocHeading("Exemplo D", 4, true, 2));
options.Headings.Add(new TocHeading("Capítulo III", 5, true, 1));
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Executar o processo
PdfManager.AddTableOfContents(options);

O exemplo demonstra como adicionar Tabela de Conteúdos a um arquivo PDF e salvar como stream.

// Criar objeto TocOptions para definir instruções
var options = new TocOptions();
// Definir o Título
options.Title = "Minha Tabela de Conteúdos";
// Projetar Títulos
options.Headings.Add(new TocHeading("Introdução", 2, false, 1));
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Definir stream de saída 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Executar o processo
PdfManager.AddTableOfContents(options);