Documentize Namespace

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

Namespace: Documentize Assembly: Documentize.dll

Class AddTimestampOptions

Informação

Representa as Opções de Carimbo de Tempo para o plugin Documentize.Timestamp.

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

Inheritance

object ← PluginBaseOptions ← AddTimestampOptions

Implements

IPluginOptions

Inherited Members

Constructors

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 = "")

Parameters

pfx Stream: O caminho para o arquivo pfx.
password string: A senha do arquivo pfx.
serverUrl string: A URL do servidor de carimbo de tempo.
serverBasicAuthCredentials string: As credenciais de autenticação básica, nome de usuário e senha 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 = "")

Parameters

pfx string: O caminho para o arquivo pfx.
password string: A senha do arquivo pfx.
serverUrl string: A URL do servidor de carimbo de tempo.
serverBasicAuthCredentials string: As credenciais de autenticação básica, nome de usuário e senha 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 ao 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 de options.Query, precedida pela mensagem com o conteúdo: “You are a helpful assistant.”, e o papel é “system”.
Em seguida (se houver) são adicionadas as mensagens da coleção options.Messages.
Mensagens de fontes de arquivo (se houver) são adicionadas por último, um objeto de mensagem para cada documento com o papel “user”. Se nenhuma mensagem for fornecida, será lançada uma ArgumentException.

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 ao 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 determinista.
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 DirectoryData

Informação

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

public sealed class DirectoryData : IData

Herança

object ← DirectoryData

Implementa

IData

Membros Herdados

Construtores

DirectoryData(string)

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

public DirectoryData(string path)

Parâmetros

path string: Uma string que representa o caminho para o diretório.

Propriedades

DataType

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

Represents options for export values of fields for Documentize.PdfForm and Documentize.PdfExtractor plugins.

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Implements

IPluginOptions

Inherited Members

Constructors

ExtractFormDataToDsvOptions(char, bool)

Initializes a new instance of the Documentize.ExtractFormDataToDsvOptions object.

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

Parameters

delimiter char: Specifies the delimiter to use in exported data between values. The default value is ‘,’.
addFieldNames bool: Add field name before value. Format: Name + delimiter + Value + delimiter.

Properties

AddFieldName

Add field name before value. Format: Name + delimiter + Value + delimiter.

public bool AddFieldName { get; set; }

Property Value

Delimiter

Delimiter used for exported values.

public char Delimiter { get; set; }

Property Value

char

Namespace: Documentize Assembly: Documentize.dll

Class ExtractImagesOptions

Informação

Represents images extraction options for the Documentize.PdfExtractor plugin.

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ExtractImagesOptions

Implements

IPluginOptions

Inherited Members

Constructors

ExtractImagesOptions()

Initializes a new instance of the Documentize.ExtractImagesOptions object with default options.

public ExtractImagesOptions()

Namespace: Documentize Assembly: Documentize.dll

Class ExtractPropertiesOptions

Informação

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

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Herança

object ← OptionsWithInput ← ExtractPropertiesOptions

Implementa

IHaveInput

Membros herdados

Construtores

ExtractPropertiesOptions()

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

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

Inicializa uma nova instância do objeto Documentize.ExtractPropertiesOptions com os dados especificados.

public ExtractPropertiesOptions(IData data)

Parâmetros

data IData: Os dados de entrada.

ExtractPropertiesOptions(string)

Inicializa uma nova instância do objeto Documentize.ExtractPropertiesOptions com o arquivo especificado.

public ExtractPropertiesOptions(string file)

Parâmetros

file string: O caminho do arquivo de entrada.

ExtractPropertiesOptions(Stream)

Inicializa uma nova instância do objeto Documentize.ExtractPropertiesOptions com o stream especificado.

public ExtractPropertiesOptions(Stream stream)

Parâmetros

stream Stream: O stream de entrada.

Propriedades

Input

Obtém ou define os Dados de Entrada.

public override IData Input { get; set; }

Valor da propriedade

Namespace: Documentize Assembly: Documentize.dll

Class ExtractTextOptions

Informação

Represents Text Extraction options for the Documentize.PdfExtractor plugin.

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Inheritance

object ← OptionsWithInput ← ExtractTextOptions

Implements

IHaveInput

Inherited Members

Constructors

ExtractTextOptions(TextFormattingMode)

Initializes a new instance of the Documentize.ExtractTextOptions object for the specified text formatting mode.

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

formattingMode TextFormattingMode: The text formatting mode value.

ExtractTextOptions(IData, TextFormattingMode)

Initializes a new instance of the Documentize.ExtractTextOptions object with the specified data.

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

Parameters

data IData: The input data.
formattingMode TextFormattingMode: The text formatting mode value.

ExtractTextOptions(string, TextFormattingMode)

Initializes a new instance of the Documentize.ExtractTextOptions object with the specified file.

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

Parameters

file string: The input file path.
formattingMode TextFormattingMode: The text formatting mode value.

ExtractTextOptions(Stream, TextFormattingMode)

Initializes a new instance of the Documentize.ExtractTextOptions object with the specified stream.

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

Parameters

stream Stream: The input stream.
formattingMode TextFormattingMode: The text formatting mode value.

Properties

FormattingMode

Gets or sets formatting mode.

public TextFormattingMode FormattingMode { get; set; }

Property Value

TextFormattingMode

Input

Gets or sets Input Data.

public override IData Input { get; set; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class FileData

Informação

Represents file data for load and save operations.

public sealed class FileData : IData

Inheritance

object ← FileData

Implements

IData

Inherited Members

Constructors

FileData(string)

Initializes new file data source with the specified path.

public FileData(string path)

Parameters

path string: A string representing the path to the source file.

Properties

DataType

Type of data source.

public DataType DataType { get; }

Property Value

Path

Gets the path to the file of the current data.

public string Path { get; }

Property Value

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

Métodos

GetFieldNames(string)

Obtém os nomes dos campos no documento PDF.

public static List<string> GetFieldNames(string path)

Parâmetros

path string: O caminho para o documento PDF.

Retorno

Lista de nomes no documento PDF.

GetFieldNames(Stream) : Obtém os nomes dos campos no documento PDF.

public static List<string> GetFieldNames(Stream stream)

Parâmetros

stream Stream: O stream com o documento PDF.

Retorno

Lista de nomes no documento PDF.

Process(FlattenFieldsOptions) : Achata os 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.

Retorno

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/base URL 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 as informações de 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 da Assembly.

public const string AssemblyVersion = "26.3.0"

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

Represents Optimize options for Documentize.PdfManager plugin.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

IPluginOptions

Inherited Members

Constructors

OptimizeOptions()

Initializes a new instance of the Documentize.OptimizeOptions object with default options. Linearize the document in order to

open the first page as quickly as possible;
display next page or follow by link to the next page as quickly as possible;
display the page incrementally as it arrives when data for a page is delivered over a slow channel (display the most useful data first);
permit user interaction, such as following a link, to be performed even before the entire page has been received and displayed.

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 OptionsWithInput

Informação

Representa as opções base para operações com 1 dado de entrada.

public abstract class OptionsWithInput : IHaveInput

Herança

object ← OptionsWithInput

Derivadas

Implementa

IHaveInput

Membros Herdados

Campos

input

Valor do Campo

Propriedades

Input

Obtém ou define os Dados de Entrada.

public virtual IData Input { get; set; }

Valor da Propriedade

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

Represents the base class for the Documentize.PdfAConverter plugin options. This class provides properties and methods for configuring the PDF/A conversion and validation process.

public abstract class PdfAOptionsBase : IPluginOptions

Inheritance

object ← PdfAOptionsBase

Derived

Implements

IPluginOptions

Inherited Members

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Properties

AlignText

Gets or sets a value indicating whether additional means are necessary to preserve text alignment during the PDF/A conversion process.

public bool AlignText { get; set; }

Property Value

Remarks

When set to true, the conversion process will attempt to restore the original text segment bounds. For the most of the documents there is no need to change this property from the default false value, as the text alignment doesn’t change during the default conversion process.

CheckDifferentNamesInFontDictionaries

Gets the flags that control the PDF/A conversion for cases when the source PDF document doesn’t correspond to the PDF specification.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Property Value

ErrorAction

Gets or sets the action to be taken for objects that cannot be converted.

public ConvertErrorAction ErrorAction { get; set; }

Property Value

ConvertErrorAction

IccProfileFileName

Gets or sets the filename of the ICC (International Color Consortium) profile to be used for the PDF/A conversion in place of the default one.

public string IccProfileFileName { get; set; }

Property Value

Inputs

Gets collection of data.

public List<idata> Inputs { get; }

Property Value

IsLowMemoryMode

Gets or sets a value indicating whether the low memory mode is enabled during the PDF/A conversion process.

public bool IsLowMemoryMode { get; set; }

Property Value

LogOutputSource

Gets or sets the data source for the log output.

public IData LogOutputSource { get; set; }

Property Value

OptimizeFileSize

Gets or sets a value indicating whether to try to reduce the file size during the PDF/A conversion process.

public bool OptimizeFileSize { get; set; }

Property Value

Remarks

When set to true, the conversion process will attempt to minimize the resulting file size. This might affect the conversion process performance.

PdfAVersion

Gets or sets the version of the PDF/A standard to be used for validation or conversion.

public PdfAStandardVersion PdfAVersion { get; set; }

Property Value

PdfAStandardVersion

Remarks

The PDF/A standard version is used to determine the compliance level for PDF/A validation and conversion. If the version is set to Documentize.PdfAStandardVersion.Auto, the system will automatically determine the appropriate PDF/A standard version for validation based on the document metadata. For the PDF/A conversion process the Documentize.PdfAStandardVersion.Auto defaults to the PDF/A-1b standard version.

SoftMaskAction

Gets or sets the action to be taken during the conversion of images with soft masks.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Property Value

ConvertSoftMaskAction

Methods

AddInput(IData)

Adds new data to the collection

public void AddInput(IData data)

Parameters

data IData: Input data. :

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

public sealed class PdfAValidationResult

Herança

object ← PdfAValidationResult

Membros Herdados

Campos

Data Obtém a fonte de dados que foi validada.
```
public readonly IData Data
```

Valor do Campo

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 usada para a 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

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 PdfConverter

Informação

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

public static class PdfConverter

Inheritance

object ← PdfConverter

Inherited Members

Examples

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

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

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

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

The example demonstrates how to convert PDF to XLSX document.

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

The example demonstrates how to convert PDF to XLS document.

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

The example demonstrates how to convert PDF to HTML document.

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

The example demonstrates how to convert HTML to PDF document.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

// Check the resultContainer.ResultCollection property for validation results for each file:
for (var i = 0; i &lt; resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Validation result for the i-th document
}

Methods

Convert(PdfToDocOptions)

Converts PDF document into DOC/DOCX formats.

public static ResultContainer Convert(PdfToDocOptions options)

Parameters

options PdfToDocOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToXlsOptions)

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

public static ResultContainer Convert(PdfToXlsOptions options)

Parameters

options PdfToXlsOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToHtmlOptions)

Converts PDF document into HTML format.

public static ResultContainer Convert(PdfToHtmlOptions options)

Parameters

options PdfToHtmlOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(HtmlToPdfOptions)

Converts HTML document into PDF format.

public static ResultContainer Convert(HtmlToPdfOptions options)

Parameters

options HtmlToPdfOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToJpegOptions)

Converts PDF document into JPEG format.

public static ResultContainer Convert(PdfToJpegOptions options)

Parameters

options PdfToJpegOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToPngOptions)

Converts PDF document into PNG format.

public static ResultContainer Convert(PdfToPngOptions options)

Parameters

options PdfToPngOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToTiffOptions)

Converts PDF document into TIFF format.

public static ResultContainer Convert(PdfToTiffOptions options)

Parameters

options PdfToTiffOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Convert(PdfToPdfAOptions)

Converts PDF document into PDF/A format.

public static ResultContainer Convert(PdfToPdfAOptions options)

Parameters

options PdfToPdfAOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

Validate(PdfAValidateOptions)

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

public static ResultContainer Validate(PdfAValidateOptions options)

Parameters

options PdfAValidateOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

If options not set.

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

Represents Documentize.PdfExtractor plugin. Used to Extract Text, Images, Form Data, Properties (Meta Data) from PDF documents.

public static class PdfExtractor

Inheritance

object ← PdfExtractor

Inherited Members

Methods

Extract(ExtractTextOptions)

Extract Text from PDF document.

public static string Extract(ExtractTextOptions options)

Parameters

options ExtractTextOptions: An options object containing instructions for the operation.

Returns

string : Extracted Text.

Examples

The example demonstrates how to Extract Text content from PDF file.

// Create ExtractTextOptions object to set input file path
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf");
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

The example demonstrates how to Extract Text content from PDF stream.

// Create ExtractTextOptions object to set input stream
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractTextOptions(stream);
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

The example demonstrates how to Extract Text content of PDF document with TextFormattingMode.

// Create ExtractTextOptions object to set input file path and TextFormattingMode
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure);
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

The example demonstrates how to Extract Text from PDF file in the shortest possible style.

// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure));

Exceptions

If options not set.

Extract(ExtractImagesOptions)

Extract images from PDF document.

public static ResultContainer Extract(ExtractImagesOptions options)

Parameters

options ExtractImagesOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to Extract Images from PDF document.

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

The example demonstrates how to Extract Images from PDF document to Streams without folder.

// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileData("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

If options not set.

Extract(ExtractFormDataToDsvOptions)

Extract Form Data from PDF document.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

options ExtractFormDataToDsvOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to Export Form values to CSV file.

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

The example demonstrates how to Export Form values to TSV file and set Properties.

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

Exceptions

If options not set.

Extract(ExtractPropertiesOptions)

Extract Properties from PDF document.

public static PdfProperties Extract(ExtractPropertiesOptions options)

Parameters

options ExtractPropertiesOptions: An options object containing instructions for the operation.

Returns

PdfProperties : An object containing the result of the operation.

Examples

The example demonstrates how to Extract Properties (FileName, Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) from PDF file.

// Create ExtractPropertiesOptions object to set input file
var options = new ExtractPropertiesOptions("path_to_your_pdf_file.pdf");
// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(options);
var filename = pdfProperties.FileName;
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

The example demonstrates how to Extract Properties (Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) from PDF stream.

// Create ExtractPropertiesOptions object to set input stream
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractPropertiesOptions(stream);
// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(options);
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

The example demonstrates how to Extract Properties from PDF file in the shortest possible style.

// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(new ExtractPropertiesOptions("path_to_your_pdf_file.pdf"));

Exceptions

If options not set.

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 os dados do 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 os valores do formulário para um arquivo CSV.

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

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 FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Flatten(options);

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

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

Exceções

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

GetNames(GetFieldNamesOptions)

Obtém os 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 a partir de um arquivo PDF.

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

Remove(RemoveFieldsOptions) : Remove Fields from PDF document.

public static ResultContainer Remove(RemoveFieldsOptions options)

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 FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Remove(options);

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, Comprimir documentos PDF e Adicionar Tabela, Adicionar Sumário aos documentos PDF. Pode Mesclar múltiplos documentos PDF em um único PDF. Pode Dividir documentos PDF em páginas individuais. Pode Otimizar, Rotacionar, Redimensionar, Comprimir documentos PDF. Pode Rotacionar, Redimensionar páginas de documento PDF. Pode Adicionar uma Tabela a um documento PDF. Pode Adicionar um Sumário a um documento PDF.

Representa o plugin Documentize.PdfManager. Usado para Mesclar, Dividir, Otimizar, Rotacionar, Redimensionar, Comprimir documentos PDF e Adicionar Tabela, Adicionar Sumário aos documentos PDF.
Pode Mesclar múltiplos documentos PDF em um único PDF.
Pode Dividir documentos PDF em páginas individuais.
Pode Otimizar, Rotacionar, Redimensionar, Comprimir documentos PDF.
Pode Rotacionar, Redimensionar páginas de documento PDF.
Pode Adicionar uma Tabela a um documento PDF.
Pode Adicionar um Sumário a um documento PDF.

public static class PdfManager

Herança

object ← PdfManager

Membros Herdados

Exemplos

O exemplo demonstra como Mesclar dois documentos PDF.

// Cria objeto MergeOptions para definir as instruções
var options = new MergeOptions();
// Adiciona caminhos dos arquivos de entrada
options.AddInput(new FileData("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileData("path_to_your_pdf_file_2.pdf"));
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Executa o processo
PdfManager.Merge(options);

O exemplo demonstra como Dividir um documento PDF.

// Cria objeto SplitOptions para definir as instruções
var options = new SplitOptions();
// Adiciona caminho do arquivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Define caminhos dos arquivos de saída
options.AddOutput(new FileData("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file_2.pdf"));
// Executa o processo
PdfManager.Split(options);

O exemplo demonstra como Otimizar um documento PDF.

// Cria objeto OptimizeOptions para definir as instruções
var options = new OptimizeOptions();
// Adiciona caminho do arquivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Executa o processo
PdfManager.Optimize(options);

O exemplo demonstra como Rotacionar um documento PDF.

// Cria objeto RotateOptions para definir as instruções
var options = new RotateOptions();
// Define nova rotação
options.Rotation = Rotation.On90;
// Adiciona caminho do arquivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Executa o processo
PdfManager.Rotate(options);

O exemplo demonstra como Redimensionar um documento PDF.

// Cria objeto ResizeOptions para definir as instruções
var options = new ResizeOptions();
// Define novo tamanho de página
options.PageSize = PageSize.A3;
// Adiciona caminho do arquivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Executa o processo
PdfManager.Resize(options);

O exemplo demonstra como Comprimir um documento PDF.

// Cria objeto CompressOptions para definir as instruções
var options = new CompressOptions();
// Adiciona caminho do arquivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Executa o processo
PdfManager.Compress(options);

O exemplo demonstra como Adicionar Tabela a um arquivo PDF.

// Configura opções de tabela
var options = new TableOptions();
options.InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Adiciona caminho do arquivo de entrada
options.AddInput(new FileData("path_to_input.pdf"));
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_output.pdf"));
// Executa o processo
PdfManager.AddTable(options);

O exemplo demonstra como adicionar Sumário a um arquivo PDF.

// Cria objeto TocOptions para definir as instruções
var options = new TocOptions();
// Define o Título
options.Title = "My Table of Contents";
// Define os cabeçalhos
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Adiciona caminho do arquivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Executa o processo
PdfManager.AddTableOfContents(options);

O exemplo demonstra como adicionar Sumário a um arquivo PDF gerando marcadores.

// Cria objeto TocOptions para definir as instruções
var options = new TocOptions();
// Define o Título
options.Title = "My Table of Contents";
// Gera links nos marcadores
options.GenerateBookmarks = true;
// Define os cabeçalhos
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
// Adiciona caminho do arquivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Executa o processo
PdfManager.AddTableOfContents(options);

O exemplo demonstra como adicionar Sumário a um arquivo PDF e salvá‑lo como fluxo.

// Cria objeto TocOptions para definir as instruções
var options = new TocOptions();
// Define o Título
options.Title = "My Table of Contents";
// Define os cabeçalhos
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Adiciona caminho do arquivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Define fluxo de saída 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Executa o processo
PdfManager.AddTableOfContents(options);

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

var options = new ChatGptRequestOptions();
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); 
options.ApiKey = "Your API key."; // É necessário fornecer a chave para acessar a API.
options.MaxTokens = 1000; // Número máximo de tokens a gerar na conclusão da conversa.

// Adiciona as mensagens da requisição.
options.Messages.Add(new Message
{
    Content = "You are a helpful assistant.",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "What is the biggest pizza diameter ever made?",
    Role = Role.User
});

// Processa a requisiçã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 da chat da API ChatGPT.

O exemplo demonstra como usar ChatGpt adicionando uma única mensagem à requisição.

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); // Adiciona o caminho do arquivo de saída.
options.ApiKey = "Your API key."; // É necessário fornecer a chave para acessar a API.
options.MaxTokens = 1000; // Número máximo de tokens a gerar na conclusão da conversa.

// Adiciona a mensagem da requisição.
// Neste caso, a mensagem de sistema com Content = "You are a helpful assistant." é adicionada por padrão.
// O papel da mensagem de consulta é "user" por padrão.
options.Query = "What is the lowest temperature recorded on the Earth?";

// Processa a requisiçã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 da chat da API ChatGPT.

O exemplo demonstra como usar Chat adicionando arquivo(s) como fonte(s) da mensagem.

var options = new ChatGptRequestOptions();
// Define caminho do arquivo de saída
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));

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

options.ApiKey = "Your API key."; // É necessário fornecer a chave para acessar a API.
options.MaxTokens = 1000; // Número máximo de tokens a gerar na conclusão da conversa.

// Adiciona a mensagem da requisição.
// Neste caso, a mensagem de sistema com Content = "You are a helpful assistant." é adicionada por padrão.
// O papel da mensagem de consulta é "user" por padrão.
options.Query = "How many letters in the provided text?";

// Processa a requisiçã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 da chat da API ChatGPT.

Métodos

AddTable(TableOptions)

Adiciona Tabela ao documento PDF.

public static ResultContainer AddTable(TableOptions options)

Parâmetros

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

Retorno

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

Exceções

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

AddTableOfContents(TocOptions)

Adiciona Sumário (TOC) ao documento PDF.

public static ResultContainer AddTableOfContents(TocOptions options)

Parâmetros

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

Retorno

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

Exceções

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

Compress(CompressOptions)

Comprime documento PDF. Tenta reduzir o tamanho do documento.

public static ResultContainer Compress(CompressOptions options)

Parâmetros

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

Retorno

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

Exceções

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

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

Cria documento PDF a partir da 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 as instruções para a operação.

Retorno

Task<ResultContainer>

Um objeto contendo o resultado da operação.

Exceções

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

Merge(MergeOptions)

Mescla documentos PDF.

public static ResultContainer Merge(MergeOptions options)

Parâmetros

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

Retorno

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

Exceções

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

Optimize(OptimizeOptions)

Otimiza documento PDF. Lineariza o documento de forma a

abrir a primeira página o mais rápido possível;
exibir a próxima página ou seguir o link para a próxima página o mais rápido possível;
exibir a página incrementalmente conforme os dados chegam em um canal lento (exibir primeiro os dados mais úteis);
permitir que a interação do usuário, como seguir um link, ocorra mesmo antes que a página inteira seja recebida e exibida.

public static ResultContainer Optimize(OptimizeOptions options)

Parâmetros

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

Retorno

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

Exceções

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

Resize(ResizeOptions)

Redimensiona páginas de documento PDF.

public static ResultContainer Resize(ResizeOptions options)

Parâmetros

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

Retorno

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

Exceções

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

Rotate(RotateOptions)

Rotaciona páginas de documento PDF.

public static ResultContainer Rotate(RotateOptions options)

Parâmetros

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

Retorno

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

Exceções

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

Split(SplitOptions)

Divide documento PDF por páginas.

public static ResultContainer Split(SplitOptions options)

Parâmetros

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

Retorno

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 PdfProperties

Informação

Representa propriedades e metainformações do documento PDF.

public class PdfProperties

Herança

object ← PdfProperties

Membros Herdados

Construtores

PdfProperties()

public PdfProperties()

Propriedades

Application

Obtém ou define a Aplicação PDF.

public string Application { get; set; }

Valor da Propriedade

Author

Obtém ou define o Autor PDF.

public string Author { get; set; }

Valor da Propriedade

Created

Obtém ou define a Data de Criação do PDF.

public DateTime Created { get; set; }

Valor da Propriedade

DateTime

FileName

Obtém ou define o Nome do Arquivo PDF, se disponível.

public string FileName { get; set; }

Valor da Propriedade

Keywords

Obtém ou define as Palavras‑Chave do PDF.

public string Keywords { get; set; }

Valor da Propriedade

Modified

Obtém ou define a Data de Modificação do PDF.

public DateTime Modified { get; set; }

Valor da Propriedade

DateTime

NumberOfPages

Obtém ou define o Número de Páginas do PDF.

public int NumberOfPages { get; set; }

Valor da Propriedade

PdfProducer

Obtém ou define o Produtor do PDF.

public string PdfProducer { get; set; }

Valor da Propriedade

Subject

Obtém ou define o Assunto do PDF.

public string Subject { get; set; }

Valor da Propriedade

Title

Obtém ou define o Título do PDF.

public string Title { get; set; }

Valor da Propriedade

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 um documento PDF.

public static ResultContainer Decrypt(DecryptOptions options)

Parâmetros

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

Retorno

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

Exemplos

O exemplo demonstra como Descriptografar um documento PDF.

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

Exceções

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

Encrypt(EncryptOptions)

Criptografa um documento PDF.

public static ResultContainer Encrypt(EncryptOptions options)

Parâmetros

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

Retorno

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

Exemplos

O exemplo demonstra como Criptografar um documento PDF.

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

Exceções

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

Sign(SignOptions)

Assina um documento PDF com assinatura digital.

public static ResultContainer Sign(SignOptions options)

Parâmetros

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

Retorno

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

Exemplos

O exemplo demonstra como Assinar um documento PDF.

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

O exemplo demonstra como Assinar um documento PDF com Stream do 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 FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
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 FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Configure invisible signature
signOptions.Visible = false;
// Perform the process
PdfSecurity.Sign(options);

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

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

O exemplo demonstra como Assinar um documento PDF com Timestamp.

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

Exceções

PdfToHtmlOptions.SaveDataType

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfToDocOptions

Informação

Representa opções do conversor de PDF para DOC do 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 pesado editado posteriormente. 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 edição adicional. Parágrafos e linhas de texto no modo fluxo permitem fácil modificação do texto, mas objetos de formatação não suportados ficarão com aparência pior do que no modo Documentize.DocConversionMode.TextBox.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToHtmlOptions

Informação

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

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToHtmlOptions

Implements

IPluginOptions

Inherited Members

Constructors

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)

Parameters

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

Properties

OutputDataType

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

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Property Value

Namespace: Documentize Assembly: Documentize.dll

Class PdfToJpegOptions

Informação

Representa opções do conversor de PDF para JPEG do 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 vai de 0 a 100. Quanto menor o número especificado, maior a compressão e, portanto, menor a qualidade da imagem. Zero fornece a imagem de menor qualidade e 100 a de maior qualidade.

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 fluxo) para salvar os resultados da operação.

public List<idata> Outputs { get; }

Valor da Propriedade

Métodos

AddOutput(IData)

Adiciona um novo destino de salvamento de resultado.

public void AddOutput(IData data)

Parâmetros

data IData: Alvo (fonte de dados de arquivo ou fluxo) 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 do conversor PDF para TIFF do plugin Documentize.PdfConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToTiffOptions

Implements

IPluginOptions

Inherited Members

Constructors

PdfToTiffOptions()

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

public PdfToTiffOptions()

Properties

ColorDepth

Obtém ou define a profundidade de cor.

public TiffColorDepth ColorDepth { get; set; }

Property Value

TiffColorDepth

Remarks

Valor padrão é Documentize.TiffColorDepth.Format32bpp.

Compression

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

public TiffCompression Compression { get; set; }

Property Value

TiffCompression

Remarks

Valor padrão é Documentize.TiffCompression.LZW.

MultiPage

Obtém e define a bandeira que permite salvar todas as páginas em um único TIFF multipágina. Valor padrão é false.

public bool MultiPage { get; set; }

Property Value

OutputResolution

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

public int OutputResolution { get; set; }

Property Value

PdfToXlsOptions.ExcelFormat

PageList

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

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

Property Value

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToXlsOptions

Informação

Representa opções de conversão 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 for necessário inserir uma coluna em branco como a primeira coluna da planilha.
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 for necessário minimizar o número de planilhas na pasta de trabalho resultante.
Valor padrão é false; isso significa que cada página PDF será salva como uma planilha separada.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Valor da Propriedade

Namespace: Documentize Assembly: Documentize.dll

Class PluginBaseOptions

Informação

Representa 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 operação ser concluída.

public bool CloseInputStreams { get; set; }

Valor da Propriedade

CloseOutputStreams

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

public bool CloseOutputStreams { get; set; }

Valor da Propriedade

Inputs

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

public List<idata> Inputs { get; }

Valor da Propriedade

Outputs

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

public List<idata> Outputs { get; }

Valor da Propriedade

Métodos

AddInput(IData)

Adiciona novos Dados às Entradas.

public void AddInput(IData data)

Parâmetros

data IData: Dados a serem adicionados.

AddOutput(IData)

Adiciona novos Dados às Saídas.

public void AddOutput(IData data)

Parâmetros

data IData: 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 em 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 as 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 o novo tamanho da 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 rotação das novas 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 Opções de Assinatura para o plugin Documentize.PdfSecurity.

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← SignOptions

Implements

IPluginOptions

Inherited Members

Constructors

SignOptions(string, string)

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

public SignOptions(string pfx, string password)

Parameters

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 as opções padrão.

public SignOptions(Stream pfx, string password)

Parameters

pfx Stream: O fluxo contendo o arquivo pfx.
password string: A senha do arquivo pfx.

Properties

Contact

O contato da assinatura.

public string Contact { get; set; }

Property Value

Location

A localização da assinatura.

public string Location { get; set; }

Property Value

Name

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

public string Name { get; set; }

Property Value

PageNumber

O número da página onde a assinatura será feita.

public int PageNumber { get; set; }

Property Value

Reason

O motivo da assinatura.

public string Reason { get; set; }

Property Value

Rectangle

O retângulo da assinatura.

public Rectangle Rectangle { get; set; }

Property Value

Rectangle

TimestampOptions

Opções de timestamp.

public TimestampOptions TimestampOptions { get; set; }

Property Value

TimestampOptions

Visible

A visibilidade da assinatura.

public bool Visible { get; set; }

Property Value

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 StreamData

Informação

Representa dados de fluxo para operações de carga e gravação.

public sealed class StreamData : IData

Herança

object ← StreamData

Implementa

IData

Membros Herdados

Construtores

StreamData(Stream)

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

public StreamData(Stream data)

Parâmetros

data Stream: Objeto Stream

Propriedades

Data

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

public Stream Data { get; }

Valor da Propriedade

Stream

DataType

Tipo de dado (stream).

public DataType DataType { get; }

Valor da Propriedade

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

Herança

object ← TableGenerator

Membros Herdados

Exemplos

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

// Configure table options
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
TableGenerator.Process(options);

Métodos

Process(TableOptions)

Adiciona tabela ao documento PDF.

public static ResultContainer Process(TableOptions options)

Parâmetros

options TableOptions: An options object containing instructions for the operation.

Retorna

ResultContainer : An object containing the result of the operation.

Exceções

Se as opções não estiverem 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()

Adiciona 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 a tabela será inserida.

Retorna

TableOptions : Instância atual de Documentize.TableOptions.

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 a tabela será inserida.

Retorna

TableOptions : Instância atual de Documentize.TableOptions.

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("The class will be deleted soon. Please use PdfExtractor class.")]
public static class TextExtractor

Herança

object ← TextExtractor

Membros herdados

Métodos

Process(ExtractTextOptions)

Extrair texto de documento PDF.

public static string Process(ExtractTextOptions options)

Parâmetros

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

Retorna

string : 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 Sumário a documentos PDF.

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

Herança

object ←
TocGenerator

Membros Herdados

Exemplos

O exemplo demonstra como adicionar um Sumário a um arquivo PDF.

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

O exemplo demonstra como adicionar um Sumário a um arquivo PDF gerando marcadores (bookmarks).

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

O exemplo demonstra como adicionar um Sumário a um arquivo PDF e salvá‑lo como fluxo (stream).

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

Métodos

Process(TocOptions)

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

Usa geração de Marcadores. Se definido como true os Marcadores serão limpos e gerados a partir dos Cabeçalhos; caso contrário, os Marcadores não serão alterados.

public bool GenerateBookmarks { get; set; }

Valor da Propriedade

Headings

Cabeçalhos ou Títulos do Sumário.

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

Valor da Propriedade

List<TocHeading>

Title

O Título do Sumário.

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 IData

Informação

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

public interface IData

Propriedades

DataType

Tipo da fonte de dados.

DataType DataType { get; }

Valor da Propriedade

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 IHaveInput

Informação

Interface de dados geral que define Dados de Entrada que as Opções devem implementar.

public interface IHaveInput

Propriedades

Entrada

Obtém ou define Dados de Entrada.

IData Input { get; set; }

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