Documentize Namespace

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

Namespace: Documentize Assembly: Documentize.dll

Class AddTimestampOptions

Informação

Representa as opções de adicionar carimbo de data/hora para o plugin Documentize.Timestamp.

[Obsolete("A classe será deletada em breve. Por favor, utilize a classe SignOptions.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← AddTimestampOptions

Implementa

IPluginOptions

Membros Herdados

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 carimbar data/hora.
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 carimbar data/hora.
serverBasicAuthCredentials string: As credenciais de autenticação básica, nome de usuário e senha são combinados em uma string “username:password”. (Opcional).

Namespace: Documentize Assembly: Documentize.dll

Class ChatCompletion

Informação

Representa uma resposta de conclusão de chat retornada pelo modelo, com base na entrada fornecida.

public class ChatCompletion

Herança

object ← ChatCompletion

Membros Herdados

Construtores

ChatCompletion()

public ChatCompletion()

Propriedades

Choices

Uma lista de opções de conclusão de chat. Pode haver mais de uma se n for maior que 1.

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

Valor da Propriedade

List<Choice>

Created

A marca temporal Unix (em segundos) de quando a conclusão de chat foi criada.

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

Valor da Propriedade

long

Id

Um identificador único para a conclusão de chat.

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

Valor da Propriedade

Model

O modelo utilizado para a conclusão de chat.

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

Valor da Propriedade

Object

O tipo de objeto, que é sempre chat.completion.

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

Valor da Propriedade

SystemFingerprint

Esta impressão digital representa a configuração de backend com a qual o modelo opera.

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

Valor da Propriedade

Usage

Estatísticas de uso para a solicitação de conclusão.

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

Valor da Propriedade

Usage

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptConsts

Informação

Esta classe representa um armazenamento para constantes.

public static class ChatGptConsts

Herança

object ← ChatGptConsts

Membros Herdados

Campos

ApiUrl

Valor do Campo

ModelName

public static string ModelName

Valor do Campo

SystemRole

public static string SystemRole

Valor do Campo

SystemRoleDescription

public static string SystemRoleDescription

Valor do Campo

UserRole

public static string UserRole

Valor do Campo

Namespace: Documentize Assembly: Documentize.dll

Class ChatGptRequestOptions

Informação

Representa opções para o plugin Documentize.PdfManager.

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← ChatGptRequestOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

ChatGptRequestOptions()

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

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

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

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

ApiUrl

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

public string ApiUrl { get; set; }

Valor da Propriedade

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 é nulo, 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) é proveniente de options.Query, precedida pela mensagem com o conteúdo: “Você é um assistente útil.”, e o papel é “sistema”.
Em seguida (se houver) são adicionadas mensagens da coleção options.Messages.
Mensagens de fontes de arquivos (se houver) são adicionadas por último, um objeto de mensagem para cada documento com o papel de “usuário”. Se nenhuma mensagem for fornecida, uma ArgumentException será lançada.

Model

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

public string Model { get; set; }

Valor da Propriedade

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Valor da Propriedade

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

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

Namespace: Documentize Assembly: Documentize.dll

Class Choice

Informação

Uma escolha de conclusão de chat.

public class Choice

Herança

object ← Choice

Membros Herdados

Construtores

Choice()

public Choice()

Propriedades

FinishReason

A razão pela qual o modelo parou de gerar tokens. Isso será interrompido se o modelo atingir um ponto de parada natural ou uma sequência de parada fornecida, ou se o número máximo de tokens especificados na solicitação foi alcançado.

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

Valor da Propriedade

Index

O índice da escolha na lista de escolhas.

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

Valor da Propriedade

Message

Uma mensagem de conclusão de chat gerada pelo modelo.

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

Valor da Propriedade

Message

Namespace: Documentize Assembly: Documentize.dll

Class CompressOptions

Informação

Representa opções de compressão para o plugin Documentize.PdfManager.

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← CompressOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

CompressOptions()

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

public CompressOptions()

Namespace: Documentize Assembly: Documentize.dll

Class DecryptionOptions

Informação

Representa Opções de Descriptografia para o plugin Documentize.Security.

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← DecryptionOptions

Implementa

IPluginOptions

Membros Herdados

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

Namespace: Documentize Assembly: Documentize.dll

Class DecryptOptions

Informação

Representa Opções de Descriptografia para o plugin Documentize.PdfSecurity.

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← DecryptOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

DecryptOptions(string)

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

public DecryptOptions(string ownerPassword)

Parâmetros

ownerPassword string: Senha do proprietário.

Propriedades

OwnerPassword

Senha do proprietário.

public string OwnerPassword { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class DirectoryDataSource

Informação

Representa dados de diretório para operações de carregamento e salvamento de um plugin.

public sealed class DirectoryDataSource : IDataSource

Herança

object ← DirectoryDataSource

Implementa

IDataSource

Membros Herdados

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

Path

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

public string Path { get; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class DocConverter

Informação

Representa o plugin Documentize.DocConverter. Usado para converter documentos PDF em formato DOC/DOCX.

[Obsolete("A classe será excluída em breve. Por favor, use a classe PdfConverter.")]
public static class DocConverter

Herança

object ← DocConverter

Membros Herdados

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

Se opções não estiverem definidas.

Namespace: Documentize Assembly: Documentize.dll

Class EncryptionOptions

Informação

Representa as Opções de Criptografia para o plugin Documentize.Security.

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← EncryptionOptions

Implementa

IPluginOptions

Membros Herdados

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

UserPassword

Senha do usuário.

public string UserPassword { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class EncryptOptions

Informação

Representa as Opções de Criptografia para o plugin Documentize.PdfSecurity.

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← EncryptOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

EncryptOptions(string, string)

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

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

UserPassword

Senha do usuário.

public string UserPassword { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class ExtractFormDataToDsvOptions

Informação

Representa opções para exportar valores de campos para os plugins Documentize.PdfForm e Documentize.PdfExtractor.

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implementa

IPluginOptions

Membros Herdados

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

Delimeter

Delimitador usado para valores exportados.

public char Delimeter { get; set; }

Valor da Propriedade

char

Namespace: Documentize Assembly: Documentize.dll

Class ExtractImagesOptions

Informação

Representa opções de extração de imagens para o plugin Documentize.PdfExtractor.

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← ExtractImagesOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

ExtractImagesOptions()

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

public ExtractImagesOptions()

Namespace: Documentize Assembly: Documentize.dll

Class ExtractTextOptions

Informação

Representa opções de extração de texto para o plugin Documentize.PdfExtractor.

public sealed class ExtractTextOptions

Herança

object ← ExtractTextOptions

Membros Herdados

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

Métodos

AddInput(IDataSource)

Adiciona novos dados a Inputs.

public void AddInput(IDataSource dataSource)

Parâmetros

dataSource IDataSource: Fonte de dados a ser adicionada. :

Namespace: Documentize Assembly: Documentize.dll

Class FileDataSource

Informação

Representa dados de arquivo para operações de carga e salvamento de um plugin.

public sealed class FileDataSource : IDataSource

Herança

object ← FileDataSource

Implementa

IDataSource

Membros Herdados

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

Path

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

public string Path { get; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class FileResult

Informação

Representa o resultado da operação na forma de um caminho de string para o arquivo.

public sealed class FileResult : IOperationResult

Herança

object ← FileResult

Implementa

IOperationResult

Membros Herdados

Propriedades

Data

Obtém os dados brutos.

public object Data { get; }

Valor da Propriedade

IsFile

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

public bool IsFile { get; }

Valor da Propriedade

IsStream

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

public bool IsStream { get; }

Valor da Propriedade

IsString

Indica se o resultado é uma string de texto.

public bool IsString { get; }

Valor da Propriedade

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.

Namespace: Documentize Assembly: Documentize.dll

Class FlattenFieldsOptions

Informação

Representa opções para achatar campos em documento pelo plugin Documentize.PdfForm.

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← FlattenFieldsOptions

Implements

IPluginOptions

Inherited Members

Constructors

FlattenFieldsOptions()

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

public FlattenFieldsOptions()

Properties

SkipFields

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

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

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class FormExporter

Informação

Representa o plugin Documentize.FormExporter. Usado para exportar valores de formulário de documentos PDF para arquivos DSV ou CSV.

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

Herança

object ← FormExporter

Membros Herdados

Métodos

Process(ExtractFormDataToDsvOptions)

Inicia o processamento do 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

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

Namespace: Documentize Assembly: Documentize.dll

Class FormExportToDsvOptions

Informação

Representa opções para exportar valores de campos para o plugin Documentize.FormExporter.

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← FormExportToDsvOptions

Implementa

IPluginOptions

Membros Herdados

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

Delimeter

Delimitador usado para valores exportados.

public char Delimeter { get; set; }

Valor da Propriedade

char

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattener

Informação

Representa o plugin Documentize.FormFlattener. Usado para achatar campos em documentos PDF.

Herança

object ← FormFlattener

Membros Herdados

Exemplos

O exemplo demonstra como achatar campos em um arquivo PDF.

// Create FormFlattenerOptions object to set instructions
var options = new FormFlattenerOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Perform the process
FormFlattener.Process(options);

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

// Get Fields Names
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// Create FormFlattenerOptions object to set instructions
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
FormFlattener.Process(options);

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

// Get Fields Names
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

Métodos

GetFieldNames(string)

Obter nomes de campos no documento PDF.

public static List<string> GetFieldNames(string path)

Parâmetros

path string: O caminho para o documento PDF.

Retorna

Lista de nomes no documento PDF.

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

public static List<string> GetFieldNames(Stream stream)

Parâmetros

stream Stream: O stream contendo o documento PDF.

Retorna

Lista de nomes no documento PDF.

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

public static ResultContainer Process(FlattenFieldsOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattenerOptions

Informação

Representa opções para achatar campos em documentos pelo plugin Documentize.FormFlattener.

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← FormFlattenerOptions

Implementa

IPluginOptions

Membros Herdados

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

Namespace: Documentize Assembly: Documentize.dll

Class GetFieldNamesOptions

Informação

Representa opções para Obter Nomes de Campos em documento pelo plugin Documentize.PdfForm.

public class GetFieldNamesOptions

Herança

object ← GetFieldNamesOptions

Membros Herdados

Construtores

GetFieldNamesOptions(string)

Construtor para opções com Caminho de entrada para o arquivo.

public GetFieldNamesOptions(string path)

Parâmetros

path string: Caminho de entrada para o arquivo.

GetFieldNamesOptions(Stream)

Construtor para opções com Fluxo de entrada.

public GetFieldNamesOptions(Stream stream)

Parâmetros

stream Stream: Fluxo de entrada.

Namespace: Documentize Assembly: Documentize.dll

Class HtmlConverter

Informação

Representa o plugin Documentize.HtmlConverter. Usado para converter documentos PDF em formato HTML e documentos HTML em formato PDF.

[Obsolete("A classe será excluída em breve. Por favor, utilize a classe PdfConverter.")]
public static class HtmlConverter

Herança

object ← HtmlConverter

Membros Herdados

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

Se options não estiver definido.

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

Se options não estiver definido.

Namespace: Documentize Assembly: Documentize.dll

Class HtmlToPdfOptions

Informação

Representa opções do conversor de HTML para PDF para o plugin Documentize.PdfConverter.

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← HtmlToPdfOptions

Implementa

IPluginOptions

Membros Herdados

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

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

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

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractor

Informação

Representa o plugin Documentize.ImageExtractor. Usado para extrair imagens de documentos PDF.

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

Herança

object ← ImageExtractor

Membros Herdados

Métodos

Process(ExtractImagesOptions)

Extrai imagens de documentos 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

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

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractorOptions

Informação

Representa opções de extração de imagens para o plugin Documentize.ImageExtractor.

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← ImageExtractorOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

ImageExtractorOptions()

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

public ImageExtractorOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Info

Informação

A classe fornece informações sobre a compilação atual do produto.

public static class Info

Herança

object ← Info

Membros Herdados

Campos

AssemblyVersion Versão do Assembly.

Valor do Campo

Produto

Nome do Produto.

public const string Product = "Documentize"

Valor do Campo

Namespace: Documentize Assembly: Documentize.dll

Class JpegConverter

Informação

Representa o plugin Documentize.JpegConverter. Usado para converter documentos PDF em formato JPEG.

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

Herança

object ← JpegConverter

Membros Herdados

Métodos

Process(PdfToJpegOptions)

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

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

Namespace: Documentize Assembly: Documentize.dll

Class License

Informação

Fornece método para definir Licença.

public static class License

Herança

object ← License

Membros Herdados

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.

Namespace: Documentize Assembly: Documentize.dll

Class MergeOptions

Informação

Representa as opções de mesclagem para o plugin Documentize.PdfManager.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← MergeOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

MergeOptions()

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

public MergeOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Merger

Informação

Representa o plugin Documentize.Merger. Usado para mesclar vários documentos PDF em um único PDF.

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

Herança

object ← Merger

Membros Herdados

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

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

Namespace: Documentize Assembly: Documentize.dll

Class Message

Informação

Uma mensagem de conclusão de chat gerada pelo modelo.

public class Message

Herança

object ← Message

Membros Herdados

Construtores

Message()

public Message()

Propriedades

Conteúdo

O conteúdo da mensagem.

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

Valor da Propriedade

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

Namespace: Documentize Assembly: Documentize.dll

Class ObjectResult

Informação

Representa o resultado da operação na forma de string.

public sealed class ObjectResult : IOperationResult

Herança

object ← ObjectResult

Implementa

IOperationResult

Membros Herdados

Propriedades

Data

Obtém dados brutos.

public object Data { get; }

Valor da Propriedade

IsFile

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

public bool IsFile { get; }

Valor da Propriedade

IsObject

Indica se o resultado é um objeto.

public bool IsObject { get; }

Valor da Propriedade

IsStream

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

public bool IsStream { get; }

Valor da Propriedade

IsString

Indica se o resultado é uma string.

public bool IsString { get; }

Valor da Propriedade

Text

Retorna a representação em string do resultado.

public string Text { get; }

Valor da Propriedade

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

Namespace: Documentize Assembly: Documentize.dll

Class OptimizeOptions

Informação

Representa opções de otimização para o plugin Documentize.PdfManager.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← OptimizeOptions

Implementa

IPluginOptions

Membros Herdados

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

Namespace: Documentize Assembly: Documentize.dll

Class Optimizer

Informação

Representa o plugin Documentize.Optimizer. Usado para Otimizar, Girar, Redimensionar, Comprimir documentos PDF.

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

Herança

object ← Optimizer

Membros Herdados

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.

Namespace: Documentize Assembly: Documentize.dll

Class PageInfo

Informação

Representa as informações da página.

public class PageInfo : PageSize

Herança

object ← PageSize ← PageInfo

Membros Herdados

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

MarginLeft

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

public double MarginLeft { get; set; }

Valor da Propriedade

MarginRight

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

public double MarginRight { get; set; }

Valor da Propriedade

MarginTop

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

public double MarginTop { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class PageSize

Informação

Classe que representa o tamanho da página em um documento PDF.

public class PageSize

Herança

object ← PageSize

Derivados

PageInfo

Membros Herdados

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

A1

Tamanho A1 (840x594 mm).

public static PageSize A1 { get; }

Valor da Propriedade

A2

Tamanho A2 (594x420 mm).

public static PageSize A2 { get; }

Valor da Propriedade

A3

Tamanho A3 (420x297 mm).

public static PageSize A3 { get; }

Valor da Propriedade

A4

Tamanho A4 (297x210 mm).

public static PageSize A4 { get; }

Valor da Propriedade

A5

Tamanho A5 (210x148 mm).

public static PageSize A5 { get; }

Valor da Propriedade

A6

Tamanho A6 (148x105 mm).

public static PageSize A6 { get; }

Valor da Propriedade

B5

Tamanho B5 (250x176 mm).

public static PageSize B5 { get; }

Valor da Propriedade

Height

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

public double Height { get; set; }

Valor da Propriedade

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

P11x17

Formato 11x17 polegadas.

public static PageSize P11x17 { get; }

Valor da Propriedade

PageLedger

Tamanho Ledger (432x279 mm).

public static PageSize PageLedger { get; }

Valor da Propriedade

PageLegal

Tamanho Legal (356x216 mm).

public static PageSize PageLegal { get; }

Valor da Propriedade

PageLetter

Tamanho Carta (279x216 mm).

public static PageSize PageLetter { get; }

Valor da Propriedade

Width

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

public double Width { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConverter

Informação

Representa um plugin para lidar com a conversão de documentos PDF para um formato PDF/A e para validação da conformidade PDF/A.

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

Herança

object ← PdfAConverter

Membros Herdados

Métodos

Process(PdfToPdfAOptions)

Converte o documento PDF para o formato PDF/A.

public static ResultContainer Process(PdfToPdfAOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Process(PdfAValidateOptions)

Verifica se o documento PDF está em 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

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConvertOptions

Informação

Representa opções para converter documentos PDF para o formato PDF/A com o plugin Documentize.PdfAConverter.

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Herança

object ← PdfAOptionsBase ← PdfAConvertOptions

Implementa

IPluginOptions

Membros Herdados

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

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfAOptionsBase

Informação

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

Implementa

IPluginOptions

Membros Herdados

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

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 esta propriedade do valor padrão false, uma vez 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

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 (Consórcio Internacional de Cores) a ser usado para a conversão de PDF/A no lugar do padrão.

public string IccProfileFileName { get; set; }

Valor da Propriedade

Inputs

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

public List<idatasource> Inputs { get; }

Valor da Propriedade

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

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

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidateOptions

Informação

Representa opções para validar a conformidade PDF/A de documentos PDF com o plugin Documentize.PdfConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Herança

object ← PdfAOptionsBase ← PdfAValidateOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

PdfAValidateOptions()

public PdfAValidateOptions()

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidationResult

Informação

Representa o resultado de um processo de validação de PDF/A.

public sealed class PdfAValidationResult

Herança

object ← PdfAValidationResult

Membros Herdados

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

ArgumentException : InvalidOperationException

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

Valor do Campo

PdfAStandardVersion

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGpt

Informação

Representa o plugin PdfChatGpt.

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

Herança

object ← PdfChatGpt

Membros Herdados

Comentários

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

Métodos

Process(IPluginOptions)

O método não possui uma 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 de tarefa representando a operação assíncrona.

Exceções

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptOptions

Informação

Representa opções para o plugin Documentize.PdfChatGpt.

public class PdfChatGptOptions : IPluginOptions

Membros Herdados

Construtores

PdfChatGptOptions()

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

public PdfChatGptOptions()

Propriedades

Inputs

public List<idatasource> Inputs { get; }

Valor da Propriedade

Outputs

public List<idatasource> Outputs { get; }

Valor da Propriedade

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptRequestOptions

Informação

Representa opções para o plugin Documentize.PdfChatGpt.

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Herança

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implementa

IPluginOptions

Membros Herdados

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

ApiUrl

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

public string ApiUrl { get; set; }

Valor da Propriedade

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

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Valor da Propriedade

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

Temperature

public double Temperature { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverter

Informação

Representa o plugin Documentize.PdfConverter. Usado para converter documentos PDF em outros formatos como DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Também permite realizar validação PDF/A e converter HTML para PDF.

public static class PdfConverter

Herança

object ← PdfConverter

Membros Herdados

Exemplos

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

// Crie um objeto PdfToDocOptions para definir as instruções
var options = new PdfToDocOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// Execute o processo
PdfConverter.Convert(options);

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

// Crie um objeto PdfToDocOptions para definir as instruções
var options = new PdfToDocOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_file.doc"));
// Defina o Modo
options.Mode = DocConversionMode.Flow;
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter PDF para o documento XLSX.

// Crie um objeto PdfToXlsOptions para definir as instruções
var options = new PdfToXlsOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xlsx"));
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter PDF para o documento XLS.

// Crie um objeto PdfToXlsOptions para definir as instruções
var options = new PdfToXlsOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Especifique o formato XLS
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_xlsx_file.xls"));
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter PDF para o documento HTML.

// Crie um objeto PdfToHtmlOptions para definir o tipo de dados de saída como arquivo com recursos incorporados
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_output.html"));
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter HTML para o documento PDF.

// Crie HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.html"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Execute o processo
PdfConverter.Convert(options);

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

// Crie um objeto PdfToJpegOptions para definir as instruções
var options = new PdfToJpegOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Defina o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Execute o processo
PdfConverter.Convert(options);

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

// Crie um objeto PdfToJpegOptions para definir as instruções
var options = new PdfToJpegOptions();
// Processar apenas a primeira página
options.PageList = [1];
// Defina a resolução de saída para 200 DPI
options.OutputResolution = 200;
// Defina a qualidade de saída para 50
options.Quality = 50;
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Defina o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Execute o processo
PdfConverter.Convert(options);

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

// Crie um objeto PdfToJpegOptions para definir as instruções
var options = new PdfToJpegOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Execute o processo
var results = PdfConverter.Convert(options);
// Obtenha os resultados do fluxo
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

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

// Crie um objeto PdfToPngOptions para definir as instruções
var options = new PdfToPngOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Defina o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter 1 página de um documento PDF em formato PNG.

// Crie um objeto PdfToPngOptions para definir as instruções
var options = new PdfToPngOptions()
// Processar apenas a primeira página
options.PageList = [1];
// Defina a resolução de saída para 200 DPI
options.OutputResolution = 200;
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Defina o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter um documento PDF em formato PNG para fluxos.

// Crie um objeto PdfToJpegOptions para definir as instruções
var options = new PdfToPngOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Execute o processo
var results = PdfConverter.Convert(options);
// Obtenha os resultados do fluxo
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

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

// Crie um objeto PdfToTiffOptions para definir as instruções
var options = new PdfToTiffOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter um documento PDF em formato TIFF com personalização de Páginas e DPI.

// Crie um objeto PdfToTiffOptions para definir as instruções
var options = new PdfToTiffOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Defina Páginas
options.PageList = [1, 3];
// Defina a resolução da imagem resultante
options.OutputResolution = 400;
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter um documento PDF em TIFF como multi-página.

// Crie um objeto PdfToTiffOptions para definir as instruções
var options = new PdfToTiffOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Habilite saída em TIFF multi-página
options.MultiPage = true;
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter um documento PDF em formato TIFF com personalização de Compressão e Profundidade de Cor.

// Crie um objeto PdfToTiffOptions para definir as instruções
var options = new PdfToTiffOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do diretório de saída
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Defina Compressão e Profundidade de Cor
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// Execute o processo
PdfConverter.Convert(options);

O exemplo demonstra como converter um documento PDF em formato TIFF para fluxos.

// Crie um objeto PdfToTiffOptions para definir as instruções
var options = new PdfToTiffOptions();
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Execute o processo
var results = PdfConverter.Convert(options);
// Obtenha os resultados do fluxo
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

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 PdfToPdfAOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

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

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

// Execute a conversão
PdfConverter.Convert(options);

O exemplo demonstra como validar o documento PDF para conformidade 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 para serem validados
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // substitua pelo caminho do seu arquivo real
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 = PdfConverter.Validate(options);

// Verifique a propriedade resultContainer.ResultCollection para 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 de validação para o i-ésimo documento
}

Métodos

Convert(PdfToDocOptions)

Converte o documento PDF em formatos DOC/DOCX.

public static ResultContainer Convert(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

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

Convert(PdfToXlsOptions)

Converte o documento PDF em formatos XLSX/XLS/CSV/XLSM/ODS.

public static ResultContainer Convert(PdfToXlsOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Convert(PdfToHtmlOptions)

Converte o documento PDF em formato HTML.

public static ResultContainer Convert(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

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

Convert(HtmlToPdfOptions)

Converte o documento HTML em formato PDF.

public static ResultContainer Convert(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

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

Convert(PdfToJpegOptions)

Converte o documento PDF em formato JPEG.

public static ResultContainer Convert(PdfToJpegOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Convert(PdfToPngOptions)

Converte o documento PDF em formato PNG.

public static ResultContainer Convert(PdfToPngOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Convert(PdfToTiffOptions)

Converte o documento PDF em formato TIFF.

public static ResultContainer Convert(PdfToTiffOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Convert(PdfToPdfAOptions)

Converte o documento PDF em formato PDF/A.

public static ResultContainer Convert(PdfToPdfAOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Validate(PdfAValidateOptions)

Verifica a conformidade do documento PDF com o formato PDF/A especificado.

public static ResultContainer Validate(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

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverterOptions

Informação

Representa opções para plugins de conversão de Pdf.

public abstract class PdfConverterOptions : IPluginOptions

Herança

object ← PdfConverterOptions

Derivados

PdfToXlsOptions

Implementa

IPluginOptions

Membros Herdados

Propriedades

Entradas

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

public List<idatasource> Inputs { get; }

Valor da Propriedade

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

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfExtractor

Informação

Representa o plugin Documentize.PdfExtractor. Usado para extrair texto, imagens e dados de formulário de documentos PDF.

public static class PdfExtractor

Inheritance

object ← PdfExtractor

Inherited Members

Methods

Extract(ExtractTextOptions)

Extrai texto de um documento PDF.

public static ResultContainer Extract(ExtractTextOptions options)

Parameters

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

Returns

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

Examples

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

// Create ExtractTextOptions object to set instructions
var options = new ExtractTextOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get the extracted text from the ResultContainer object
var textExtracted = results.ResultCollection[0].ToString();

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

// Create ExtractTextOptions object to set TextFormattingMode
var options = new ExtractTextOptions(TextFormattingMode.Pure);
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get the extracted text from the ResultContainer object
var textExtracted = results.ResultCollection[0].ToString();

Exceptions

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

Extract(ExtractImagesOptions)

Extrai imagens de um documento PDF.

public static ResultContainer Extract(ExtractImagesOptions options)

Parameters

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

Returns

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

Examples

O exemplo demonstra como extrair imagens de um documento PDF.

// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get path to image result
var imageExtracted = results.ResultCollection[0].ToFile();

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

// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Not set output - it will write results to streams
// Perform the process
var results = PdfExtractor.Extract(options);
// Get Stream
var ms = results.ResultCollection[0].ToStream();
// Copy data to file for demo
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

Exceptions

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

Extract(ExtractFormDataToDsvOptions)

Extrai dados de formulário de um documento PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

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

Returns

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

Examples

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

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

Exceptions

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfForm

Informação

Representa o plugin Documentize.PdfForm. Usado para achatar, extrair dados de formulários. Também permite obter nomes dos campos.

public static class PdfForm

Herança

object ← PdfForm

Membros Herdados

Métodos

Extract(ExtractFormDataToDsvOptions)

Extrai dados de formulário de um documento PDF.

public static ResultContainer Extract(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.

Exemplos

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

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

Exceções

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

Flatten(FlattenFieldsOptions)

Achata campos em um documento PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Parâmetros

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

Retorna

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

Exemplos

O exemplo demonstra como achatar campos em um arquivo PDF.

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

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

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

Exceções

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

GetNames(GetFieldNamesOptions)

Obtém nomes dos campos em um documento PDF.

public static List<string> GetNames(GetFieldNamesOptions options)

Parâmetros

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

Retorna

Lista de nomes no documento PDF.

Exemplos

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

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

Remove(RemoveFieldsOptions) : Remove campos de um documento PDF.

public static ResultContainer Remove(RemoveFieldsOptions options)

Parâmetros

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

Retorna

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

Exemplos

O exemplo demonstra como remover campos de um arquivo PDF.

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

Informação

Representa o plugin Documentize.PdfManager. Usado para Mesclar, Dividir, Otimizar, Rotacionar, Redimensionar, Compactar documentos PDF e Adicionar Tabela, Adicionar TOC a 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 um Índice ao documento PDF.

public static class PdfManager

Herança

object ← PdfManager

Membros Herdados

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("caminho_para_seu_arquivo_pdf_1.pdf"));
options.AddInput(new FileDataSource("caminho_para_seu_arquivo_pdf_2.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.pdf"));
// Realizar 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("caminho_para_seu_arquivo_pdf.pdf"));
// Definir caminhos dos arquivos de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante_1.pdf"));
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante_2.pdf"));
// Realizar 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("caminho_para_seu_arquivo_pdf.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.pdf"));
// Realizar 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("caminho_para_seu_arquivo_pdf.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.pdf"));
// Realizar 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 de Página
options.PageSize = PageSize.A3;
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("caminho_para_seu_arquivo_pdf.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.pdf"));
// Realizar 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("caminho_para_seu_arquivo_pdf.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.pdf"));
// Realizar o processo
PdfManager.Compress(options);

O exemplo demonstra como Adicionar Tabela ao arquivo PDF.

// Configurar opções da tabela
var options = new TableOptions();
options.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("caminho_para_entrada.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_saida.pdf"));
// Realizar o processo
PdfManager.AddTable(options);

O exemplo demonstra como adicionar Índice ao arquivo PDF.

// Criar objeto TocOptions para definir instruções
var options = new TocOptions();
// Definir o Título
options.Title = "Meu Índice";
// Projetar Cabeçalhos
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("caminho_para_seu_arquivo_pdf.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.pdf"));
// Realizar o processo
PdfManager.AddTableOfContents(options);

O exemplo demonstra como adicionar Índice ao arquivo PDF com geração de marcadores.

// Criar objeto TocOptions para definir instruções
var options = new TocOptions();
// Definir o Título
options.Title = "Meu Índice";
// Gerar links nos marcadores
options.GenerateBookmarks = true;
// Projetar Cabeçalhos
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("caminho_para_seu_arquivo_pdf.pdf"));
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.pdf"));
// Realizar o processo
PdfManager.AddTableOfContents(options);

O exemplo demonstra como adicionar Índice ao arquivo PDF e salvar como stream.

// Criar objeto TocOptions para definir instruções
var options = new TocOptions();
// Definir o Título
options.Title = "Meu Índice";
// Projetar Cabeçalhos
options.Headings.Add(new TocHeading("Introdução", 2, false, 1));
// Adicionar caminho do arquivo de entrada
options.AddInput(new FileDataSource("caminho_para_seu_arquivo_pdf.pdf"));
// Definir stream de saída 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Realizar o processo
PdfManager.AddTableOfContents(options);

O exemplo demonstra como usar o ChatGpt adicionando mensagens à solicitação.

var options = new ChatGptRequestOptions();
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.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.

// Adicionar as mensagens de solicitaçã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
});

// Processar a solicitação.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(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 ChatGpt adicionando uma mensagem à solicitação.

var options = new ChatGptRequestOptions();
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.pdf")); // Adicionar 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.

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

// Processar a solicitação.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(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 Chat adicionando arquivo(s) como fonte(s) da mensagem.

var options = new ChatGptRequestOptions();
// Definir caminho do arquivo de saída
options.AddOutput(new FileDataSource("caminho_para_arquivo_pdf_resultante.pdf"));

// Adicionar a fonte de texto PDF.
// No caso de múltiplas fontes, o texto de cada documento será adicionado à coleção de mensagens de solicitação
// como uma mensagem separada com o papel "user".
options.AddInput(new FileDataSource("TextoFonte.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.

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

// Processar a solicitação.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(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.

Métodos

AddTable(TableOptions)

Adicionar Tabela ao documento PDF.

public static ResultContainer AddTable(TableOptions options)

Parâmetros

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

Retorna

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

Exceções

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

AddTableOfContents(TocOptions)

Adicionar Índice (TOC) ao documento PDF.

public static ResultContainer AddTableOfContents(TocOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Compress(CompressOptions)

Compactar o documento PDF. Tentar reduzir o tamanho do documento.

public static ResultContainer Compress(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.

Exceções

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

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

Criar documento PDF pela Resposta do ChatGpt. Usado para enviar solicitações ao ChatGPT diretamente ou adicionando fontes de arquivos PDF e salvar a resposta na fonte de saída.

public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

Parâmetros

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

Retorna

Task<ResultContainer>

Um objeto contendo o resultado da operação.

Exceções

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

Merge(MergeOptions)

Mesclar documentos PDF.

public static ResultContainer Merge(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

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

Optimize(OptimizeOptions)

Otimizar documento PDF. Linearizar o documento para que

abrir a primeira página o mais rápido possível;
exibir a próxima página ou seguir pelo link para a próxima página o mais rápido possível;
exibir a página incrementalmente à medida que ela chega quando os dados para uma página são entregues através de 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 toda a página tenha sido recebida e exibida.

public static ResultContainer Optimize(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.

Exceções

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

Resize(ResizeOptions)

Redimensionar Páginas do documento PDF.

public static ResultContainer Resize(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.

Exceções

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

Rotate(RotateOptions)

Rotacionar Páginas do documento PDF.

public static ResultContainer Rotate(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.

Exceções

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

Split(SplitOptions)

Dividir documento PDF por páginas.

public static ResultContainer Split(SplitOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfSecurity

Informação

Representa o plugin Documentize.PdfSecurity. Usado para criptografar, descriptografar e assinar documentos PDF.

public static class PdfSecurity

Herança

object ← PdfSecurity

Membros Herdados

Métodos

Decrypt(DecryptOptions)

Descriptografa documento PDF.

public static ResultContainer Decrypt(DecryptOptions options)

Parâmetros

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

Retorna

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

Exemplos

O exemplo demonstra como Descriptografar um documento PDF.

// Crie um objeto DecryptOptions para definir instruções
var options = new DecryptOptions("123456");
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realize o processo
PdfSecurity.Decrypt(options);

Exceções

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

Encrypt(EncryptOptions)

Criptografa documento PDF.

public static ResultContainer Encrypt(EncryptOptions options)

Parâmetros

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

Retorna

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

Exemplos

O exemplo demonstra como Criptografar um documento PDF.

// Crie um objeto EncryptOptions para definir instruções
var options = new EncryptOptions("123456", "qwerty");
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realize o processo
PdfSecurity.Encrypt(options);

Exceções

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

Sign(SignOptions)

Assina documento PDF por assinatura digital.

public static ResultContainer Sign(SignOptions options)

Parâmetros

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

Retorna

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

Exemplos

O exemplo demonstra como Assinar um documento PDF.

// Crie um objeto SignOptions para definir instruções
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realize o processo
PdfSecurity.Sign(options);

O exemplo demonstra como Assinar um documento PDF com Stream de Arquivo PFX.

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realize o processo
PdfSecurity.Sign(options);

O exemplo demonstra como Assinar um documento PDF com assinatura invisível.

var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Configurar assinatura invisível
signOptions.Visible = false;
// Realize o processo
PdfSecurity.Sign(options);

O exemplo demonstra como Assinar um documento PDF com opções extras.

// Crie um objeto SignOptions para definir instruções
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Parâmetros opcionais
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Realize o processo
PdfSecurity.Sign(options);

O exemplo demonstra como Assinar documento PDF com Timestamp.

// Crie um objeto SignOptions para definir instruções
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file");
options.TimestampOptions = new TimestampOptions("server_url");
// Adicione o caminho do arquivo de entrada
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Defina o caminho do arquivo de saída
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Realize o processo
PdfSecurity.Sign(options);

Exceções

PdfToHtmlOptions.SaveDataType

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfToDocOptions

Informação

Representa opções de conversor de PDF para DOC para o plugin Documentize.PdfConverter.

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← PdfToDocOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

PdfToDocOptions()

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

public PdfToDocOptions()

Propriedades

Mode

Permite controlar como um documento PDF é convertido em um documento de processamento de texto.

public DocConversionMode Mode { get; set; }

Valor da Propriedade

DocConversionMode

Observações

Use o modo Documentize.DocConversionMode.TextBox quando o documento resultante não for ser editado extensivamente. Caixas de texto são fáceis de modificar quando não há muito a fazer.

Use o modo Documentize.DocConversionMode.Flow quando o documento de saída precisar de mais edição. Parágrafos e linhas de texto no modo de fluxo permitem fácil modificação do texto, mas objetos de formatação não suportados ficarão piores do que no modo Documentize.DocConversionMode.TextBox.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToHtmlOptions

Informação

Representa opções do conversor de PDF para HTML para o plugin Documentize.PdfConverter.

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← PdfToHtmlOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

PdfToHtmlOptions(SaveDataType)

Inicializa uma nova instância do objeto Documentize.PdfToHtmlOptions para o tipo de dado de saída especificado.

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

Parâmetros

outputDataType PdfToHtmlOptions.SaveDataType: Tipo de dado de saída.

Propriedades

OutputDataType

Obtém o tipo de dado de saída.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class PdfToJpegOptions

Informação

Representa opções do conversor de PDF para JPEG para o plugin Documentize.PdfConverter.

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← PdfToJpegOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

PdfToJpegOptions()

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

public PdfToJpegOptions()

Propriedades

OutputResolution

Obtém ou define o valor de resolução das imagens resultantes.

public int OutputResolution { get; set; }

Valor da Propriedade

PageList

Obtém ou define uma lista de páginas para o processo.

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

Valor da Propriedade

List<int>

Quality

Obtém e define a qualidade de saída. Especifica o nível de compressão para uma imagem. A faixa de valores úteis para a qualidade é de 0 a 100. Quanto menor o número especificado, maior a compressão e, portanto, menor a qualidade da imagem. Zero resultaria na imagem de qualidade mais baixa e 100 na mais alta.

public int Quality { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPdfAOptions

Informação

Representa opções para converter documentos PDF para o formato PDF/A com o plugin Documentize.PdfConverter.

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

Herança

object ← PdfAOptionsBase ← PdfToPdfAOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

PdfToPdfAOptions()

public PdfToPdfAOptions()

Propriedades

Outputs

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

public List<idatasource> Outputs { get; }

Valor da Propriedade

Métodos

AddOutput(IDataSource)

Adiciona um novo destino para salvar o resultado.

public void AddOutput(IDataSource dataSource)

Parâmetros

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPngOptions

Informação

Representa opções de conversão de PDF para PNG para o plugin Documentize.PdfConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← PdfToPngOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

PdfToPngOptions()

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

public PdfToPngOptions()

Propriedades

OutputResolution

Obtém ou define o valor de resolução das imagens resultantes.

public int OutputResolution { get; set; }

Valor da Propriedade

PageList

Obtém ou define uma lista de páginas para o processo.

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

Valor da Propriedade

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToTiffOptions

Informação

Representa opções de conversão de PDF para TIFF para o plugin Documentize.PdfConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← PdfToTiffOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

PdfToTiffOptions()

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

public PdfToTiffOptions()

Propriedades

ColorDepth

Obtém ou define a profundidade de cor.

public TiffColorDepth ColorDepth { get; set; }

Valor da Propriedade

TiffColorDepth

Observações

O valor padrão é Documentize.TiffColorDepth.Format32bpp.

Compression

Obtém ou define o tipo de compressão.

public TiffCompression Compression { get; set; }

Valor da Propriedade

TiffCompression

Observações

O valor padrão é Documentize.TiffCompression.LZW.

MultiPage

Obtém e define um indicador que permite salvar todas as páginas em um TIFF multipágina. O valor padrão é falso.

public bool MultiPage { get; set; }

Valor da Propriedade

OutputResolution

Obtém ou define o valor de resolução das imagens resultantes.

public int OutputResolution { get; set; }

Valor da Propriedade

PdfToXlsOptions.ExcelFormat

PageList

Obtém ou define uma lista de páginas para o processo.

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

Valor da Propriedade

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToXlsOptions

Informação

Representa as opções do conversor de PDF para XLS/XLSX para o plugin Documentize.PdfConverter.

public sealed class PdfToXlsOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← PdfToXlsOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

PdfToXlsOptions()

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

public PdfToXlsOptions()

Propriedades

Format

Formato de saída.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Valor da Propriedade

InsertBlankColumnAtFirst

Defina como true se precisar inserir uma coluna em branco como a primeira coluna da planilha. O valor padrão é false; isso significa que a coluna em branco não será inserida.

public bool InsertBlankColumnAtFirst { get; set; }

Valor da Propriedade

MinimizeTheNumberOfWorksheets

Defina como true se precisar minimizar o número de planilhas no workbook resultante. O valor padrão é false; isso significa que cada página PDF será salva como planilha separada.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class PluginBaseOptions

Informação

Representa as opções base para plugins.

public class PluginBaseOptions : IPluginOptions

Herança

object ← PluginBaseOptions

Derivados

Implementa

IPluginOptions

Membros herdados

Propriedades

CloseInputStreams

Fecha os fluxos de entrada após a conclusão da operação.

public bool CloseInputStreams { get; set; }

Valor da propriedade

CloseOutputStreams

Fecha os fluxos de saída após a conclusão da operação.

public bool CloseOutputStreams { get; set; }

Valor da propriedade

Inputs

Retorna os dados de Entrada para a operação.

public List<idatasource> Inputs { get; }

Valor da propriedade

Outputs

Retorna os dados de Saída para a operação.

public List<idatasource> Outputs { get; }

Valor da propriedade

Métodos

AddInput(IDataSource)

Adiciona novos Dados às Entradas.

public void AddInput(IDataSource dataSource)

Parâmetros

dataSource IDataSource: Dados a serem adicionados.

AddOutput(IDataSource)

Adiciona novos Dados às Saídas.

public void AddOutput(IDataSource saveDataSource)

Parâmetros

saveDataSource IDataSource: Dados a serem adicionados. :

Namespace: Documentize Assembly: Documentize.dll

Class PngConverter

Informação

Representa o plugin Documentize.PngConverter. Usado para converter documentos PDF em formato PNG.

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

Herança

object ← PngConverter

Membros Herdados

Métodos

Process(PdfToPngOptions)

Converte documento PDF em formato PNG.

public static ResultContainer Process(PdfToPngOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Class Rectangle

Informação

Classe representa um retângulo.

public class Rectangle

Herança

object ← Rectangle

Membros Herdados

Construtores

Rectangle(double, double, double, double)

Construtor de Rectangle.

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

Parâmetros

llx double: X do canto inferior esquerdo.
lly double: Y do canto inferior esquerdo.
urx double: X do canto superior direito.
ury double: Y do canto superior direito.

Namespace: Documentize Assembly: Documentize.dll

Class RemoveFieldsOptions

Informação

Representa opções para Remover Campos no documento pelo plugin Documentize.PdfForm.

public class RemoveFieldsOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← RemoveFieldsOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

RemoveFieldsOptions()

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

public RemoveFieldsOptions()

Namespace: Documentize Assembly: Documentize.dll

Class ResizeOptions

Informação

Representa opções de redimensionamento para o plugin Documentize.PdfManager.

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← ResizeOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

ResizeOptions()

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

public ResizeOptions()

Propriedades

PageSize

Obtém ou define um novo tamanho de página.

public PageSize PageSize { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class ResultContainer

Informação

Representa um contêiner que contém a coleção de resultados do processamento do plugin.

public class ResultContainer

Herança

object ← ResultContainer

Membros Herdados

Propriedades

ResultCollection

Obtém a coleção dos resultados da operação

public List<ioperationresult> ResultCollection { get; }

Valor da Propriedade

List<IOperationResult>

Namespace: Documentize Assembly: Documentize.dll

Class RotateOptions

Informação

Representa opções de rotação para o plugin Documentize.PdfManager.

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← RotateOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

RotateOptions()

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

public RotateOptions()

Propriedades

Rotation

Obtém ou define a nova rotação das páginas.

public Rotation Rotation { get; set; }

Valor da Propriedade

Rotation

Namespace: Documentize Assembly: Documentize.dll

Class Security

Informação

Representa o plugin Documentize.Security. Usado para criptografar e descriptografar documentos PDF.

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

Herança

object ← Security

Membros Herdados

Métodos

Process(EncryptOptions)

Criptografar documento PDF.

public static ResultContainer Process(EncryptOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Process(DecryptOptions)

Descriptografar documento PDF.

public static ResultContainer Process(DecryptOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Class SignOptions

Informação

Representa as Opções de Assinatura para o plugin Documentize.PdfSecurity.

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← SignOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

SignOptions(string, string)

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

public SignOptions(string pfx, string password)

Parâmetros

pfx string: O caminho para o arquivo pfx.
password string: A senha do arquivo pfx.

SignOptions(Stream, string)

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

public SignOptions(Stream pfx, string password)

Parâmetros

pfx Stream: O stream com o arquivo pfx.
password string: A senha do arquivo pfx.

Propriedades

Contact

O contato da assinatura.

public string Contact { get; set; }

Valor da Propriedade

Location

A localização da assinatura.

public string Location { get; set; }

Valor da Propriedade

Name

O nome do campo de assinatura existente. Nulo para criar um novo campo.

public string Name { get; set; }

Valor da Propriedade

PageNumber

O número da página na qual a assinatura é feita.

public int PageNumber { get; set; }

Valor da Propriedade

Reason

A razão da assinatura.

public string Reason { get; set; }

Valor da Propriedade

Rectangle

O retângulo da assinatura.

public Rectangle Rectangle { get; set; }

Valor da Propriedade

Rectangle

TimestampOptions

Opções de Timestamp.

public TimestampOptions TimestampOptions { get; set; }

Valor da Propriedade

TimestampOptions

Visible

A visibilidade da assinatura.

public bool Visible { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class SplitOptions

Informação

Representa opções de divisão para o plugin Documentize.PdfManager.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← SplitOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

SplitOptions()

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

public SplitOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Splitter

Informação

Representa o plugin Documentize.Splitter. Usado para dividir documentos PDF em páginas separadas.

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

Herança

object ← Splitter

Membros Herdados

Métodos

Process(SplitOptions)

Divide o documento PDF por páginas.

public static ResultContainer Process(SplitOptions options)

Parâmetros

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

Retornos

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Class StreamDataSource

Informação

Representa a fonte de dados de stream para operações de carga e salvamento de um plugin.

public sealed class StreamDataSource : IDataSource

Herança

object ← StreamDataSource

Implementa

IDataSource

Membros Herdados

Construtores

StreamDataSource(Stream)

Inicializa uma nova fonte de dados de stream com o objeto de stream especificado.

public StreamDataSource(Stream data)

Parâmetros

data Stream: Objeto de stream

Propriedades

Data

Obtém o objeto de stream da fonte de dados atual.

public Stream Data { get; }

Valor da Propriedade

Stream

DataType

Tipo da fonte de dados (stream).

public DataType DataType { get; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class StreamResult

Informação

Representa o resultado da operação na forma de Stream.

public sealed class StreamResult : IOperationResult

Herança

object ← StreamResult

Implementa

IOperationResult

Membros Herdados

Propriedades

Data

Obtém os dados brutos.

public object Data { get; }

Valor da Propriedade

IsFile

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

public bool IsFile { get; }

Valor da Propriedade

IsStream

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

public bool IsStream { get; }

Valor da Propriedade

IsString

Indica se o resultado é uma string.

public bool IsString { get; }

Valor da Propriedade

Métodos

ToFile()

Tenta converter o resultado em 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 em um objeto de stream.

public Stream ToStream()

Retorna

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

Namespace: Documentize Assembly: Documentize.dll

Class StringResult

Informação

Representa o resultado da operação na forma de string.

public sealed class StringResult : IOperationResult

Herança

object ← StringResult

Implementa

IOperationResult

Membros Herdados

Propriedades

Data

Obtém os dados brutos.

public object Data { get; }

Valor da Propriedade

IsFile

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

public bool IsFile { get; }

Valor da Propriedade

IsStream

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

public bool IsStream { get; }

Valor da Propriedade

IsString

Indica se o resultado é uma string.

public bool IsString { get; }

Valor da Propriedade

Text

Retorna a representação em string do resultado.

public string Text { get; }

Valor da Propriedade

Métodos

ToFile()

Tenta converter o resultado em 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 em 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.

ToString()

Tenta converter o resultado em uma string.

public override string ToString()

Retorna

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

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

Informação

A classe representa um construtor para tabela na página pdf.

public class TableBuilder

Herança

object ← TableBuilder

Derivados

TableRowBuilder

Membros Herdados

Métodos

AddRow()

Adiciona uma nova linha à tabela.

public virtual TableRowBuilder AddRow()

Retorna

TableRowBuilder : Instância do atual Documentize.TableRowBuilder.

AddTable()

Adiciona uma nova tabela ao documento.

public TableBuilder AddTable()

Retorna

TableBuilder : Instância do atual Documentize.TableBuilder.

InsertPageAfter(int)

Insere a página após a página especificada.

public TableOptions InsertPageAfter(int page)

Parâmetros

page int: Número da página para inserir a tabela após.

Retorna

TableOptions : Instância do atual Documentize.TableOptions.

InsertPageBefore(int)

Insere a página antes da página especificada.

public TableOptions InsertPageBefore(int page)

Parâmetros

page int: Número da página para inserir a tabela após.

Retorna

TableOptions : Instância do atual Documentize.TableOptions.

Operadores

operador implícito TableOptions(TableBuilder)

Converte o construtor Documentize.TableBuilder em opções Documentize.TableOptions

public static implicit operator TableOptions(TableBuilder builder)

Parâmetros

builder TableBuilder: Instância do atual Documentize.TableBuilder.

Retorna

TableOptions : Resultado da conversão para PdfGeneratorTableOptions.

Namespace: Documentize Assembly: Documentize.dll

Class TableCellBuilder

Informação

Classe representa o construtor para célula da tabela.

public class TableCellBuilder : TableRowBuilder

Herança

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

Membros Herdados

Métodos

AddCell()

Adicionar célula à tabela.

public override TableCellBuilder AddCell()

Retorna

TableCellBuilder : Instância do atual Documentize.TableCellBuilder.

AddParagraph(params string[])

Adicionar parágrafos à célula da tabela.

public TableCellBuilder AddParagraph(params string[] paragraphs)

Parâmetros

paragraphs string[]: Texto para os Parágrafos.

Retorna

TableCellBuilder : Instância do atual Documentize.TableCellBuilder.

Namespace: Documentize Assembly: Documentize.dll

Class TableGenerator

Informação

Representa o plugin Documentize.TableGenerator. Usado para adicionar uma tabela a um documento PDF.

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

Herança

object ← TableGenerator

Membros Herdados

Exemplos

O exemplo demonstra como adicionar uma tabela a um arquivo PDF.

// Configurar 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"));
// Realizar o processo
TableGenerator.Process(options);

Métodos

Process(TableOptions)

Adiciona tabela ao documento PDF.

public static ResultContainer Process(TableOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Class TableOptions

Informação

Representa opções para adicionar tabela ao documento pelo plugin Documentize.PdfManager.

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← TableOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

TableOptions()

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

public TableOptions()

Métodos

AddTable()

Adicionando tabela ao documento.

public TableBuilder AddTable()

Retorna

TableBuilder : Nova instância de Documentize.TableBuilder.

Create()

Cria uma instância de Documentize.TableOptions.

public static TableOptions Create()

Retorna

TableOptions : Nova instância de Documentize.TableOptions.

InsertPageAfter(int)

Insere página após a página especificada.

public TableOptions InsertPageAfter(int page)

Parâmetros

page int: Número da página após a qual inserir a tabela.

Retorna

TableOptions : Instância do Documentize.TableOptions atual.

InsertPageBefore(int)

Insere página antes da página especificada.

public TableOptions InsertPageBefore(int page)

Parâmetros

page int: Número da página antes da qual inserir a tabela.

Retorna

TableOptions : Instância do Documentize.TableOptions atual.

Namespace: Documentize Assembly: Documentize.dll

Class TableRowBuilder

Informação

Classe representa construtor para linha de tabela.

public class TableRowBuilder : TableBuilder

Herança

object ← TableBuilder ← TableRowBuilder

Derivados

TableCellBuilder

Membros Herdados

Métodos

AddCell()

Adicionar célula à linha da tabela.

public virtual TableCellBuilder AddCell()

Retorna

TableCellBuilder : Instância de Documentize.TableCellBuilder criada.

AddRow()

Sobrescrevendo AddRow.

public override TableRowBuilder AddRow()

Retorna

TableRowBuilder : Instância da Documentize.TableRowBuilder atual.

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractor

Informação

Representa o plugin Documentize.TextExtractor. Usado para extrair texto de documentos PDF.

[Obsolete("A classe será excluída em breve. Por favor, use a classe PdfExtractor.")]
public static class TextExtractor

Herança

object ← TextExtractor

Membros Herdados

Métodos

Process(ExtractTextOptions)

Extrair texto de documento PDF.

public static ResultContainer Process(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

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

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractorOptions

Informação

Representa opções de extração de texto para o plugin Documentize.TextExtractor.

public sealed class TextExtractorOptions

Herança

object ← TextExtractorOptions

Membros Herdados

Construtores

TextExtractorOptions(TextFormattingMode)

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

public TextExtractorOptions(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 os dados de Inputs para a operação.

public List<idatasource> Inputs { get; }

Valor da Propriedade

Métodos

AddInput(IDataSource)

Adiciona novos dados a Inputs.

public void AddInput(IDataSource dataSource)

Parâmetros

dataSource IDataSource: Fonte de dados a ser adicionada. :

Namespace: Documentize Assembly: Documentize.dll

Class TiffConverter

Informação

Representa o plugin Documentize.TiffConverter. Usado para converter documentos PDF em formato TIFF.

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

Herança

object ← TiffConverter

Membros Herdados

Métodos

Process(PdfToTiffOptions)

Converte documentos PDF em formato TIFF.

public static ResultContainer Process(PdfToTiffOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Class Timestamp

Informação

Representa o plugin Documentize.Timestamp. Usado para adicionar Timestamp a um documento.

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

Herança

object ← Timestamp

Membros Herdados

Métodos

Process(AddTimestampOptions)

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

public static ResultContainer Process(AddTimestampOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Class TimestampOptions

public class TimestampOptions

Herança

object ← TimestampOptions

Membros Herdados

Construtores

TimestampOptions(string, string)

Inicializa uma nova instância da classe Documentize.TimestampOptions.

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

Parâmetros

serverUrl string: A URL do servidor de timestamp.
basicAuthCredentials string: As credenciais de autenticação básica, o nome de usuário e a senha são combinados em uma string “username:password”.

Propriedades

BasicAuthCredentials

Obtém/configura as credenciais de autenticação básica, o nome de usuário e a senha são combinados em uma string “username:password”.

public string BasicAuthCredentials { get; set; }

Valor da Propriedade

ServerUrl

Obtém/configura a URL do servidor de timestamp.

public string ServerUrl { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class TocGenerator

Informação

Representa o plugin Documentize.TocGenerator. Usado para adicionar um Índice a documentos PDF.

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

Herança

object ← TocGenerator

Membros Herdados

Exemplos

O exemplo demonstra como adicionar um Índice a um arquivo PDF.

// Cria um objeto TocOptions para definir instruções
var options = new TocOptions();
// Define o Título
options.Title = "Meu Índice";
// Designa Cabeçalhos
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));
// 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_pdf_resultado.pdf"));
// Realiza o processo
TocGenerator.Process(options);

O exemplo demonstra como adicionar um Índice a um arquivo PDF gerando marcadores.

// Cria um objeto TocOptions para definir instruções
var options = new TocOptions();
// Define o Título
options.Title = "Meu Índice";
// Gera links nos marcadores
options.GenerateBookmarks = true;
// Designa Cabeçalhos
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));
// 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_pdf_resultado.pdf"));
// Realiza o processo
TocGenerator.Process(options);

O exemplo demonstra como adicionar um Índice a um arquivo PDF e salvar como fluxo.

// Cria um objeto TocOptions para definir instruções
var options = new TocOptions();
// Define o Título
options.Title = "Meu Índice";
// Designa Cabeçalhos
options.Headings.Add(new TocHeading("Introdução", 2, false, 1));
// Adiciona o caminho do arquivo de entrada
options.AddInput(new FileDataSource("caminho_para_seu_arquivo_pdf.pdf"));
// Define o fluxo de saída 
var outputStream = new MemoryStream();
options.AddOutput(new StreamDataSource(outputStream));
options.CloseOutputStreams = false;
// Realiza o processo
TocGenerator.Process(options);

Métodos

Process(TocOptions)

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

public static ResultContainer Process(TocOptions options)

Parâmetros

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

Retorna

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

Namespace: Documentize Assembly: Documentize.dll

Class TocHeading

Informação

Representa opções para Cabeçalhos ou Títulos de Índices a ser documentado pelo plugin Documentize.PdfManager.

public class TocHeading

Herança

object ← TocHeading

Membros Herdados

Construtores

TocHeading(string, int, bool, int)

Inicializa uma nova instância do Documentize.TocHeading.

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

Parâmetros

text string: O Texto do Cabeçalho.
pageNumber int: Número da Página para o link.
generateNumbering bool: Usando geração de Números.
level int: O Nível.

Propriedades

GenerateNumbering

Usando geração de Números. Se true, a numeração deve ser feita automaticamente; caso contrário, a numeração deve ser feita manualmente.

public bool GenerateNumbering { get; set; }

Valor da Propriedade

Level

O Nível. Usado para geração de Números.

public int Level { get; set; }

Valor da Propriedade

PageNumber

O Número da Página para o link.

public int PageNumber { get; set; }

Valor da Propriedade

Text

O Texto do Título.

public string Text { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class TocOptions

Informação

Representa opções para adicionar um índice ao documento pelo plugin Documentize.PdfManager.

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← TocOptions

Implementa

IPluginOptions

Membros Herdados

Construtores

TocOptions()

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

public TocOptions()

Propriedades

GenerateBookmarks

Usando geração de Marcadores. Se configurado como true, os Marcadores serão limpos e gerados pelos Títulos; caso contrário, os Marcadores não mudarão.

public bool GenerateBookmarks { get; set; }

Valor da Propriedade

Headings

Títulos ou Cabeçalhos do Índice.

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

Valor da Propriedade

List<TocHeading>

Title

O Título do Índice.

public string Title { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class Usage

Informação

Estatísticas de uso para a solicitação de conclusão.

public class Uso

Herança

object ← Uso

Membros Herdados

Construtores

Uso()

public Uso()

Propriedades

CompletionTokens

Número de tokens na conclusão gerada.

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

Valor da Propriedade

PromptTokens

Número de tokens na solicitação.

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

Valor da Propriedade

TotalTokens

Número total de tokens usados na solicitação (solicitação + conclusão).

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

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class XlsConverter

Informação

Representa o plugin Documentize.XlsConverter. Usado para converter documentos PDF em formatos XLSX/XLS/CSV/XLSM/ODS.

[Obsolete("A classe será excluída em breve. Por favor, use a classe PdfConverter.")]
public static class XlsConverter

Herança

object ← XlsConverter

Membros Herdados

Métodos

Process(PdfToXlsOptions)

Converte o documento PDF em formatos XLSX/XLS/CSV/XLSM/ODS.

public static ResultContainer Process(PdfToXlsOptions options)

Parâmetros

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

Retorna

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

Exceções

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

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertErrorAction

Informação

Esta classe representa ações para erros de conversão.

public enum ConvertErrorAction

Campos

Delete = 0
None = 1

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertSoftMaskAction

Informação

Esta ação representa ações para conversão de imagens com máscara suave.

public enum ConvertSoftMaskAction

Campos

ConvertToStencilMask = 1: A máscara suave será convertida em máscara de estêncil.
Default = 0: Usar estratégia padrão.

Namespace: Documentize Assembly: Documentize.dll

Enum DataType

Informação

Representa os tipos possíveis de dados para processamento de plugins.

public enum DataType

Campos

Directory = 2: O tipo de dado é um diretório representado pelo caminho até ele.
File = 0: O tipo de dado é um arquivo representado pelo caminho até ele.
Stream = 1: O tipo de dado é um fluxo.

Namespace: Documentize Assembly: Documentize.dll

Enum DocConversionMode

Informação

Define o modo de conversão do documento de saída.

public enum DocConversionMode

Campos

Flow = 1: Modo de reconhecimento completo, o mecanismo realiza agrupamento e análise em múltiplos níveis para restaurar a intenção original do autor do documento e produzir um documento maximamente editável. A desvantagem é que o documento de saída pode parecer diferente do arquivo PDF original.
TextBox = 0: Este modo é rápido e bom para preservar ao máximo a aparência original do arquivo PDF, mas a editabilidade do documento resultante pode ser limitada. Cada bloco de texto visualmente agrupado no arquivo PDF original é convertido em uma caixa de texto no documento resultante. Isso alcança uma semelhança máxima do documento de saída com o arquivo PDF original. O documento de saída terá uma boa aparência, mas consistirá inteiramente de caixas de texto, o que pode dificultar a edição posterior do documento no Microsoft Word. Este é o modo padrão.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlMediaType

Informação

Especifica os tipos de mídia possíveis usados durante a renderização.

public enum HtmlMediaType

Campos

Print = 0: Impressão.
Screen = 1: Tela.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlPageLayoutOption

Informação

Especifica bandeiras que, juntas, outras opções determinam tamanhos e layouts de páginas.

public enum HtmlPageLayoutOption

Campos

FitToWidestContentWidth = 3: Indica que a largura da página é determinada pelo tamanho do conteúdo em si, não pela largura de página especificada.
None = 0: Valor padrão que indica que o HtmlPageLayoutOption não afetará os tamanhos e layouts das páginas.
ScaleToPageWidth = 256: Indica que o conteúdo do documento será escalado para caber na página.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfAStandardVersion

Informação

Especifica a versão do padrão PDF/A para um documento PDF.

public enum PdfAStandardVersion

Campos

Auto = 0: A versão do padrão PDF/A é determinada automaticamente.
PDF_A_1A = 1: Especifica a versão do padrão PDF/A-1a.
PDF_A_1B = 2: Especifica a versão do padrão PDF/A-1b.
PDF_A_2A = 3: Especifica a versão do padrão PDF/A-2a.
PDF_A_2B = 4: Especifica a versão do padrão PDF/A-2b.
PDF_A_2U = 5: Especifica a versão do padrão PDF/A-2u.
PDF_A_3A = 6: Especifica a versão do padrão PDF/A-3a.
PDF_A_3B = 7: Especifica a versão do padrão PDF/A-3b.
PDF_A_3U = 8: Especifica a versão do padrão PDF/A-3u.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfToHtmlOptions.SaveDataType

Informação

Define o tipo de saída do arquivo HTML.

public enum PdfToHtmlOptions.SaveDataType

Campos

FileWithEmbeddedResources = 1: Salvar HTML em arquivo com recursos incorporados
FileWithExternalResources = 0: Salvar HTML em arquivo com recursos externos
StreamWithEmbeddedResources = 2: Salvar HTML em fluxo de arquivo com recursos incorporados

Namespace: Documentize Assembly: Documentize.dll

Enum PdfToXlsOptions.ExcelFormat

Informação

Permite especificar o formato de arquivo xls/xlsx/xml/csv. O valor padrão é XLSX.

public enum PdfToXlsOptions.ExcelFormat

Campos

CSV = 2: Um formato de arquivo de valores separados por vírgula (.csv).
ODS = 4: Planilha de Documento Aberto.
XLSM = 3: Um formato de arquivo Office Open XML habilitado para macro (.xlsm).
XLSX = 1: Formato de arquivo Office Open XML (.xlsx).
XMLSpreadSheet2003 = 0: Formato de arquivo Excel 2003 XML (.xls).

Namespace: Documentize Assembly: Documentize.dll

Enum Role

Informação

O papel do autor das mensagens.

public enum Role

Campos

Assistant = 2
System = 1
User = 0

Namespace: Documentize Assembly: Documentize.dll

Enum Rotation

Informação

Enumeração dos valores de rotação possíveis.

public enum Rotation

Campos

None = 0: Não rotacionado.
On180 = 2: Rotacionado em 180 graus.
On270 = 3: Rotacionado em 270 graus no sentido horário.
On360 = 4: Rotacionado em 360 graus no sentido horário.
On90 = 1: Rotacionado em 90 graus no sentido horário.

Namespace: Documentize Assembly: Documentize.dll

Enum TextExtractorOptions.TextFormattingMode

Informação

Define diferentes modos que podem ser usados ao converter um documento PDF em texto. Veja a classe Documentize.TextExtractorOptions.

public enum TextExtractorOptions.TextFormattingMode

Campos

Plain = 2: Representa o conteúdo de texto PDF levando em conta a posição relativa dos fragmentos de texto, mas sem adicionar espaços extras.
Pure = 0: Representa o conteúdo de texto PDF com algumas rotinas de formatação. Isso inclui levar em conta posições relativas e adicionar espaços extras para alinhar o texto à largura da página.
Raw = 1: Representa o conteúdo PDF como está, ou seja, sem formatação.

Namespace: Documentize Assembly: Documentize.dll

Enum TextFormattingMode

Informação

Define diferentes modos que podem ser usados ao converter um documento PDF em texto. Veja a classe Documentize.ExtractTextOptions.

public enum TextFormattingMode

Campos

Flatten = 2: Representa o conteúdo PDF com fragmentos de texto posicionados por suas coordenadas. É basicamente semelhante ao modo “Raw”. Mas enquanto “Raw” foca em preservar a estrutura dos fragmentos de texto (operadores) em um documento, “Flatten” se concentra em manter o texto na ordem em que é lido.
Pure = 0: Representa o conteúdo de texto PDF com algumas rotinas de formatação. Isso inclui considerar posições relativas e adicionar espaços extras para alinhar o texto à largura da página.
Raw = 1: Representa o conteúdo PDF como está, ou seja, sem formatação.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffColorDepth

Informação

Usado para especificar a Profundidade de Cor para as Documentize.PdfToTiffOptions.

public enum TiffColorDepth

Campos

Format1bpp = 4: 1 bit por pixel.
Format24bpp = 1: 24 bits por pixel. Rgb.
Format32bpp = 0: 32 bits por pixel. Usado por padrão.
Format4bpp = 3: 4 bits por pixel.
Format8bpp = 2: 8 bits por pixel.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffCompression

Informação

Utilizado para especificar o tipo de compressão para as opções Documentize.PdfToTiffOptions.

public enum TiffCompression

Campos

CCITT3 = 2: Especifica o esquema de compressão CCITT3. Pode ser passado para o codificador CCITT3 como um parâmetro que pertence à categoria de compressão.
CCITT4 = 1: Especifica o esquema de compressão CCITT4. Pode ser passado para o codificador CCITT4 como um parâmetro que pertence à categoria de compressão.
LZW = 0: Especifica o esquema de compressão LZW. Pode ser passado para o codificador Tiff como um parâmetro que pertence à categoria de compressão.
None = 4: Especifica nenhuma compressão. Pode ser passado para o codificador Tiff como um parâmetro que pertence à categoria de compressão.
RLE = 3: Especifica o esquema de compressão RLE. Pode ser passado para o codificador RLE como um parâmetro que pertence à categoria de compressão.

Namespace: Documentize Assembly: Documentize.dll

Interface IDataSource

Informação

Interface geral de dados que define membros comuns que dados concretos devem implementar.

public interface IDataSource

Propriedades

DataType

Tipo da fonte de dados.

DataType DataType { get; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Interface IOperationResult

Informação

Interface geral de resultado de operação que define métodos comuns que o resultado de operação de plugin concreto deve implementar.

public interface IOperationResult

Propriedades

Data

Obtém dados brutos.

object Data { get; }

Valor da Propriedade

IsFile

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

bool IsFile { get; }

Valor da Propriedade

IsStream

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

bool IsStream { get; }

Valor da Propriedade

IsString

Indica se o resultado é uma string de texto.

bool IsString { get; }

Valor da Propriedade