Ação ConvertSoftMaskEnum

public enum ConvertSoftMaskAction

Campos

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

Assinatura da Classe

public sealed class Signature

Herança

object ← Signature

Membros Herdados

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

Exemplos

O exemplo demonstre como assinar um documento PDF.

// criar Assinatura
var plugin = new Signature();
// criar objeto SignOptions para definir instruções
var opt = new SignOptions(inputPfx, inputPfxPassword);
// adicionar caminho do arquivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// definir caminho do arquivo de saída
opt.AddOutput(new FileDataSource(outputPath));
// realizar o processo
plugin.Process(opt);

Construtores

Signature()

public Signature()

Métodos

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Parâmetros

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

Retorna

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

Exceções

InvalidOperationException

Classe AddTimestampOptions

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions  

Herança

object ←
PluginBaseOptions ←
AddTimestampOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

AddTimestampOptions(Stream, string, string, string)

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

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

Parâmetros

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

AddTimestampOptions(string, string, string, string)

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

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

Parâmetros

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

Classe CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions  

Herança

object ←
PluginBaseOptions ←
CompressOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

CompressOptions()

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

public CompressOptions()  

Classe DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← DecryptionOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

DecryptionOptions(string)

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

public DecryptionOptions(string ownerPassword)

Parâmetros

• ownerPassword string: Senha do proprietário.

Propriedades

OwnerPassword

Senha do proprietário.

public string OwnerPassword { get; set; }

Valor da Propriedade

string

Classe DocConverter

public sealed class DocConverter

Herança

object ← DocConverter

Membros Herdados

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

Exemplos

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

// criar DocConverter
var plugin = new DocConverter();
// criar objeto PdfToDocOptions para definir instruções
var opt = new PdfToDocOptions();
// adicionar caminho do arquivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// definir caminho do arquivo de saída
opt.AddOutput(new FileDataSource(outputPath));
// realizar o processo
plugin.Process(opt);

Construtores

DocConverter()

public DocConverter()

Métodos

Dispose()

Implementação de IDisposable.

public void Dispose()

Process(PdfToDocOptions)

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

public ResultContainer Process(PdfToDocOptions options)

Parâmetros

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

Retorna

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

Classe EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← EncryptionOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

EncryptionOptions(string, string)

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

public EncryptionOptions(string ownerPassword, string userPassword)

Parâmetros

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

Propriedades

OwnerPassword

Senha do proprietário.

public string OwnerPassword { get; set; }

Valor da Propriedade

string

UserPassword

Senha do usuário.

public string UserPassword { get; set; }

Valor da Propriedade

string

Classe FileResult

public sealed class FileResult : IOperationResult

Herança

object ← FileResult

Implementa

• IOperationResult

Membros Herdados

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

Propriedades

Data

Obtém dados brutos.

public object Data { get; }

Valor da Propriedade

object

IsFile

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

public bool IsFile { get; }

Valor da Propriedade

bool

IsStream

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

public bool IsStream { get; }

Valor da Propriedade

bool

IsString

Indica se o resultado é uma string de texto.

public bool IsString { get; }

Valor da Propriedade

bool

Métodos

ToFile()

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

Classe HtmlConverter

public sealed class HtmlConverter : IDisposable

Herança

object ← HtmlConverter

Implementa

• IDisposable

Membros Herdados

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

Exemplos

O exemplo demonstra como converter PDF para documento HTML.

// criar HtmlConverter
var plugin = new HtmlConverter();
// criar objeto PdfToHtmlOptions para definir o tipo de dados de saída como arquivo com recursos incorporados
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// adicionar caminho do arquivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// definir caminho do arquivo de saída
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

O exemplo demonstra como converter HTML para documento PDF.

// criar HtmlConverter
var plugin = new HtmlConverter();
// criar HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// adicionar caminho do arquivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// definir caminho do arquivo de saída
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Construtores

HtmlConverter()

public HtmlConverter()

Métodos

Dispose()

Implementação de IDisposable.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Parâmetros

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

Retorna

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

Classe HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← HtmlToPdfOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

HtmlToPdfOptions()

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

public HtmlToPdfOptions()

Propriedades

BasePath

O caminho/base URL para o arquivo HTML.

public string BasePath { get; set; }

Valor da Propriedade

string

HtmlMediaType

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

public HtmlMediaType HtmlMediaType { get; set; }

Valor da Propriedade

HtmlMediaType

IsRenderToSinglePage

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

public bool IsRenderToSinglePage { get; set; }

Valor da Propriedade

bool

PageInfo

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

public PageInfo PageInfo { get; set; }

Valor da Propriedade

PageInfo

PageLayoutOption

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

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Valor da Propriedade

HtmlPageLayoutOption

Classe ImageExtractor

public class ImageExtractor : PdfExtractor, IDisposable

Herança

object ← PdfExtractor ← ImageExtractor

Implementa

• IDisposable

Membros Herdados

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

Exemplos

O exemplo demonstra como extrair imagens de um documento PDF.

// criar objeto ImageExtractor para extrair imagens
using (var plugin = new ImageExtractor())
{
    // criar ImageExtractorOptions
    var opt = new ImageExtractorOptions();

    // adicionar caminho do arquivo de entrada
    opt.AddInput(new FileDataSource(inputPath));
    // definir diretório de saída
    opt.AddInput(new FileDataSource("D:\\"));

    // realizar processo de extração
    var resultContainer = plugin.Process(opt);

    // obter a imagem do objeto ResultContainer
    var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}

Construtores

ImageExtractor()

public ImageExtractor()

Classe ImageExtractorOptions

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions

Herança

object ← PdfExtractorOptions ← ImageExtractorOptions

Implementa

• IPluginOptions

Membros Herdados

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

Observações

Herda funções para adicionar dados (arquivos, streams) representando documentos PDF de entrada.

Construtores

ImageExtractorOptions()

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

public ImageExtractorOptions()

Propriedades

OperationName

Retorna o nome da operação.

public override string OperationName { get; }

Valor da Propriedade

string

Classe JpegConverter

public sealed class JpegConverter

Herança

object ← JpegConverter

Membros Herdados

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

Exemplos

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

// criar JpegConverter
var plugin = new JpegConverter();
// criar objeto PdfToJpegOptions para definir instruções
var opt = new PdfToJpegOptions();
// adicionar caminho do arquivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// definir caminho do arquivo de saída
opt.AddOutput(new DirectoryDataSource(outputPath));
// realizar o processo
plugin.Process(opt);

Construtores

JpegConverter()

public JpegConverter()

Métodos

Process(PdfToJpegOptions)

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

public ResultContainer Process(PdfToJpegOptions options)

Parâmetros

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

Retorna

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

Classe ObjectResult

public sealed class ObjectResult : IOperationResult

Herança

object ← ObjectResult

Implementa

• IOperationResult

Membros Herdados

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

Propriedades

Data

Obtém os dados brutos.

public object Data { get; }

Valor da Propriedade

object

IsFile

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

public bool IsFile { get; }

Valor da Propriedade

bool

IsObject

Indica se o resultado é um objeto.

public bool IsObject { get; }

Valor da Propriedade

bool

IsStream

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

public bool IsStream { get; }

Valor da Propriedade

bool

IsString

Indica se o resultado é uma string.

public bool IsString { get; }

Valor da Propriedade

bool

Text

Retorna a representação em string do resultado.

public string Text { get; }

Valor da Propriedade

string

Métodos

ToFile()

Tenta converter o resultado em um arquivo.

public string ToFile()

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 um stream; 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().

Classe OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← OptimizeOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

OptimizeOptions()

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

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

public OptimizeOptions()

Classe PageInfo

public class PageInfo : PageSize

Herança

object ← PageSize ← PageInfo

Membros Herdados

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

Construtores

PageInfo()

Construtor de Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Construtor de Documentize.PageInfo.

public PageInfo(double width, double height)

Parâmetros

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

Propriedades

MarginBottom

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

public double MarginBottom { get; set; }

Valor da Propriedade

double

MarginLeft

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

public double MarginLeft { get; set; }

Valor da Propriedade

double

MarginRight

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

public double MarginRight { get; set; }

Valor da Propriedade

double

MarginTop

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

public double MarginTop { get; set; }

Valor da Propriedade

double

Classe PageSize

public class PageSize

Herança

Object ← PageSize

Derivados

• PageInfo

Membros Herdados

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

Construtores

PageSize()

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

public PageSize()

PageSize(double, double)

Construtor de Documentize.PageSize.

public PageSize(double width, double height)

Parâmetros

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

Propriedades

A0

Tamanho A0 (1189x840 mm).

public static PageSize A0 { get; }

Valor da Propriedade

PageSize

A1

Tamanho A1 (840x594 mm).

public static PageSize A1 { get; }

Valor da Propriedade

PageSize

A2

Tamanho A2 (594x420 mm).

public static PageSize A2 { get; }

Valor da Propriedade

PageSize

A3

Tamanho A3 (420x297 mm).

public static PageSize A3 { get; }

Valor da Propriedade

PageSize

A4

Tamanho A4 (297x210 mm).

public static PageSize A4 { get; }

Valor da Propriedade

PageSize

A5

Tamanho A5 (210x148 mm).

public static PageSize A5 { get; }

Valor da Propriedade

PageSize

A6

Tamanho A6 (148x105 mm).

public static PageSize A6 { get; }

Valor da Propriedade

PageSize

B5

Tamanho B5 (250x176 mm).

public static PageSize B5 { get; }

Valor da Propriedade

PageSize

Height

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

public double Height { get; set; }

Valor da Propriedade

double

IsLandscape

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

public bool IsLandscape { get; }

Valor da Propriedade

bool

P11x17

Formato 11x17 polegadas.

public static PageSize P11x17 { get; }

Valor da Propriedade

PageSize

PageLedger

Tamanho Ledger (432x279 mm).

public static PageSize PageLedger { get; }

Valor da Propriedade

PageSize

PageLegal

Tamanho Legal (356x216 mm).

public static PageSize PageLegal { get; }

Valor da Propriedade

PageSize

PageLetter

Tamanho Carta (279x216 mm).

public static PageSize PageLetter { get; }

Valor da Propriedade

PageSize

Width

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

public double Width { get; set; }

Valor da Propriedade

double

Classe PdfAConverter

``csharp public sealed class PdfAConverter

#### Herança

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

#### Membros Herdados

- [object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
- [object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring),
- [object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
- [object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
- [object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
- [object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

## Exemplos

O exemplo demonstra como validar a conformidade do documento PDF com o formato PDF/A (PDF/A-1a neste caso):
```cs
// Cria a classe de opções para configurar o processo de validação
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

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

// Cria a instância do plugin
var plugin = new PdfAConverter();

// Executa a validação e obtém os resultados
var resultContainer = plugin.Process(options);

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

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

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

// Adiciona o arquivo de origem
options.AddInput(new FileDataSource("caminho_para_seu_arquivo_pdf.pdf")); // substitua pelo caminho real do seu arquivo

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

// Cria a instância do plugin
var plugin = new PdfAConverter();

// Executa a conversão
plugin.Process(options);

Construtores

PdfAConverter()

public PdfAConverter()

Métodos

Process(IPluginOptions)

Inicia um processo de conversão ou validação de PDF/A com as opções fornecidas.

public ResultContainer Process(IPluginOptions options)

Parâmetros

• options IPluginOptions: Um objeto de opções contendo instruções para o plugin. Deve ser uma instância de Documentize.PdfAConvertOptions ou da classe Documentize.PdfAValidateOptions.

Retorna

ResultContainer : Um objeto Documentize.ResultContainer contendo o resultado do processamento.

Classe PdfAOptionsBase

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

public abstract class PdfAOptionsBase : IPluginOptions  

Herança

object ←
PdfAOptionsBase

Derivados

• PdfAConvertOptions,
• PdfAValidateOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfAOptionsBase()

protected PdfAOptionsBase()  

Propriedades

AlignText

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

public bool AlignText { get; set; }  

Valor da Propriedade

bool

Observações

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

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }  

Valor da Propriedade

bool

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }  

Valor da Propriedade

ConvertErrorAction

IccProfileFileName

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

public string IccProfileFileName { get; set; }  

Valor da Propriedade

string

Inputs

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

public List<idatasource> Inputs { get; }  

Valor da Propriedade

List<IDataSource&gt;

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }  

Valor da Propriedade

bool

LogOutputSource

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

public IDataSource LogOutputSource { get; set; }  

Valor da Propriedade

IDataSource

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }  

Valor da Propriedade

bool

Observações

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

PdfAVersion

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

public PdfAStandardVersion PdfAVersion { get; set; }  

Valor da Propriedade

PdfAStandardVersion

Observações

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

SoftMaskAction

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

public ConvertSoftMaskAction SoftMaskAction { get; set; }  

Valor da Propriedade

ConvertSoftMaskAction

Métodos

AddInput(IDataSource)

Adiciona uma nova fonte de dados à coleção

public void AddInput(IDataSource dataSource)  

Parâmetros

• dataSource IDataSource:

Classe PdfAValidationResult

public sealed class PdfAValidationResult

Herança

object ← PdfAValidationResult

Membros Herdados

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

Campos

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

Valor do Campo

IDataSource

IsValid

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

public readonly bool IsValid

Valor do Campo

bool

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

Valor do Campo

PdfAStandardVersion

Classe PdfChatGpt

public sealed class PdfChatGpt : IDisposable

Herança

object ← PdfChatGpt

Implementa

• IDisposable

Membros Herdados

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

Exemplos

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

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Adicione o caminho do arquivo de saída.
    options.ApiKey = "Sua chave de API."; // É necessário fornecer a chave para acessar a API.
    options.MaxTokens = 1000; // O número máximo de tokens a serem gerados na conclusão do chat.

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

    // Processar a solicitação.
    var result = await plugin.ProcessAsync(options);

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

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

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Adicione o caminho do arquivo de saída.
    options.ApiKey = "Sua chave de API."; // É necessário fornecer a chave para acessar a API.
    options.MaxTokens = 1000; // O número máximo de tokens a serem gerados na conclusão do chat.

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

    // Processar a solicitação.
    var result = await plugin.ProcessAsync(options);

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

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

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Adicione o caminho do arquivo de saída.

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

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

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

    // Processar a solicitação.
    var result = await plugin.ProcessAsync(options);

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

Observações

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

Construtores

PdfChatGpt()

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

public PdfChatGpt()

Métodos

Dispose()

Implementação de IDisposable. Na verdade, não é necessário para PdfChatGpt.

public void Dispose()

Process(IPluginOptions)

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

public 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 Task<resultcontainer> ProcessAsync(IPluginOptions options)

Parâmetros

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

Retorna

Task<ResultContainer&gt;

O objeto de tarefa que representa a operação assíncrona.

Exceções

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

Define o token de cancelamento.

public void SetCancellationToken(CancellationToken cancellationToken)

Parâmetros

• cancellationToken CancellationToken: O token de cancelamento. :

Classe PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Herança

object ← PdfChatGptOptions

Derivados

• PdfChatGptRequestOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfChatGptOptions()

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

public PdfChatGptOptions()

Propriedades

Entradas

public List<idatasource> Inputs { get; }

Valor da Propriedade

List<IDataSource&gt;

Saídas

public List<idatasource> Outputs { get; }

Valor da Propriedade

List<IDataSource&gt;

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 os resultados da operação de salvamento. :

Classe PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Herança

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfChatGptRequestOptions()

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

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

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

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

Parâmetros

• apiKey string: A chave para acessar a API do ChatGPT.
• model string: O nome do modelo 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 requisição para o ChatGPT.

Propriedades

ApiKey

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

public string ApiKey { get; set; }

Valor da Propriedade

string

ApiUrl

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

public string ApiUrl { get; set; }

Valor da Propriedade

string

MaxTokens

Número máximo de tokens na resposta. O valor padrão é nulo, significando 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&gt;

Model

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

public string Model { get; set; }

Valor da Propriedade

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Valor da Propriedade

int

Query

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

public string Query { get; set; }

Valor da Propriedade

string

Temperature

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

public double Temperature { get; set; }

Valor da Propriedade

double

Classe PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions

Herança

object ← PdfConverterOptions

Derivados

• PdfToDocOptions,
• PdfToHtmlOptions,
• PdfToXlsOptions

Implementa

• IPluginOptions

Membros Herdados

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

Propriedades

Entradas

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

public List<idatasource> Inputs { get; }

Valor da Propriedade

List<IDataSource&gt;

Saídas

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

public List<idatasource> Outputs { get; }

Valor da Propriedade

List<IDataSource&gt;

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

Exceções

NotImplementedException

Classe PdfExtractor

public abstract class PdfExtractor : IDisposable

Herança

object ← PdfExtractor

Derivados

• ImageExtractor,
• TextExtractor

Implementa

• IDisposable

Membros Herdados

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

Exemplos

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

// criar objeto TextExtractor para extrair conteúdos PDF
using (TextExtractor extractor = new TextExtractor())
{
    // criar objeto TextExtractorOptions para definir instruções
    textExtractorOptions = new TextExtractorOptions();

    // adicionar caminho do arquivo de entrada
    textExtractorOptions.AddInput(new FileDataSource(inputPath));

    // realizar o processo de extração
    ResultContainer resultContainer = extractor.Process(textExtractorOptions);

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

Observações

O objeto Documentize.TextExtractor é utilizado para extrair texto, ou Documentize.ImageExtractor para extrair imagens.

Construtores

PdfExtractor()

protected PdfExtractor()

Métodos

Dispose()

Implementação de IDisposable. Na verdade, não é necessário para PdfExtractor.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions pdfExtractorOptions)

Parâmetros

• pdfExtractorOptions IPluginOptions: Um objeto de opções contendo instruções para o PdfExtractor.

Retorna

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

Classe PdfExtractorOptions

public abstract class PdfExtractorOptions : IPluginOptions

Herança

object ← PdfExtractorOptions

Derivados

• ImageExtractorOptions,
• TextExtractorOptions

Implementa

• IPluginOptions

Membros Herdados

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

Observações

O Documentize.PdfExtractorOptions contém funções base para adicionar dados (arquivos, streams) representando documentos PDF de entrada. Por favor, crie Documentize.TextExtractorOptions ou ImageExtractorOptions em vez disso.

Propriedades

Inputs

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

public List<idatasource> Inputs { get; }

Valor da Propriedade

List<IDataSource&gt;

OperationName

Retorna o nome da operação

public virtual string OperationName { get; }

Valor da Propriedade

string

Métodos

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Parâmetros

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

Classe PdfToDocOptions

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions

Herança

object ← PdfConverterOptions ← PdfToDocOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfToDocOptions()

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

public PdfToDocOptions()

Classe PdfToHtmlOptions

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions  

Herança

object ←
PdfConverterOptions ←
PdfToHtmlOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfToHtmlOptions()

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

public PdfToHtmlOptions()  

PdfToHtmlOptions(SaveDataType)

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

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)  

Parâmetros

• outputDataType PdfToHtmlOptions.SaveDataType: Tipo de dados de saída.

Propriedades

OutputDataType

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

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }  

Valor da Propriedade

PdfToHtmlOptions.SaveDataType

Classe PdfToJpegOptions

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions  

Herança

object ←
PluginBaseOptions ←
PdfToJpegOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfToJpegOptions()

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

public PdfToJpegOptions()  

Propriedades

OutputResolution

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

public int OutputResolution { get; set; }  

Valor da Propriedade

int

PageList

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

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

Valor da Propriedade

List<int&gt;

Quality

Obtém e define a qualidade de saída.

public int Quality { get; set; }  

Valor da Propriedade

int

Classe PdfToPngOptions

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← PdfToPngOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

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

int

PageList

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

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

Valor da Propriedade

List<int&gt;

Classe PdfToTiffOptions

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← PdfToTiffOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfToTiffOptions()

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

public PdfToTiffOptions()

Propriedades

MultiPage

Obtém e define um flag que permite salvar todas as páginas em um TIFF de múltiplas páginas.

public bool MultiPage { get; set; }

Valor da Propriedade

bool

OutputResolution

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

public int OutputResolution { get; set; }

Valor da Propriedade

int

PageList

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

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

Valor da Propriedade

List<int&gt;

Classe PdfToXlsOptions

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

Herança

object ← PdfConverterOptions ← PdfToXlsOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

PdfToXlsOptions()

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

public PdfToXlsOptions()

Propriedades

Formato

Formato de saída.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Valor da Propriedade

PdfToXlsOptions.ExcelFormat

InserirColunaEmBrancoPrimeira

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

public bool InsertBlankColumnAtFirst { get; set; }

Valor da Propriedade

bool

MinimizarONúmeroDePlanilhas

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

public bool MinimizeTheNumberOfWorksheets { get; set; }

Valor da Propriedade

bool

Classe PluginBaseOptions

public class PluginBaseOptions : IPluginOptions

Herança

object ← PluginBaseOptions

Derivados

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

Implementa

• IPluginOptions

Membros Herdados

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

Propriedades

CloseInputStreams

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

public bool CloseInputStreams { get; set; }

Valor da Propriedade

bool

CloseOutputStreams

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

public bool CloseOutputStreams { get; set; }

Valor da Propriedade

bool

Inputs

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

public List<idatasource> Inputs { get; }

Valor da Propriedade

List<IDataSource&gt;

Outputs

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

public List<idatasource> Outputs { get; }

Valor da Propriedade

List<IDataSource&gt;

Métodos

AddInput(IDataSource)

Adiciona novos dados a Inputs.

public void AddInput(IDataSource dataSource)

Parâmetros

• dataSource IDataSource: Dados a adicionar.

AddOutput(IDataSource)

Adiciona novos dados a Outputs.

public void AddOutput(IDataSource saveDataSource)

Parâmetros

• saveDataSource IDataSource: Dados a adicionar. :

Classe PngConverter

csharp
public sealed class PngConverter

Herança

object ← PngConverter

Membros Herdados

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

Exemplos

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

// criar PngConverter
var plugin = new PngConverter();
// criar objeto PdfToPngOptions para definir instruções
var opt = new PdfToPngOptions();
// adicionar caminho do arquivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// definir caminho do arquivo de saída
opt.AddOutput(new DirectoryDataSource(outputPath));
// realizar o processo
plugin.Process(opt);

Construtores

PngConverter()

public PngConverter()

Métodos

Process(PdfToPngOptions)

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

public ResultContainer Process(PdfToPngOptions options)

Parâmetros

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

Retorna

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

Classe ResizeOptions

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← ResizeOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

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

PageSize

Classe ResultContainer

public class ResultContainer

Herança

object ← ResultContainer

Membros Herdados

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

Propriedades

ResultCollection

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

public List<ioperationresult> ResultCollection { get; }

Valor da Propriedade

List<IOperationResult&gt;

Classe Retângulo

public class Rectangle  

Herança

object ←
Rectangle

Membros Herdados

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

Construtores

Rectangle(double, double, double, double)

Construtor de Retângulo.

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.

Classe StreamDataSource

public sealed class StreamDataSource : IDataSource  

Herança

object ←
StreamDataSource

Implementa

• IDataSource

Membros Herdados

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

Construtores

StreamDataSource(Stream)

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

public StreamDataSource(Stream data)  

Parâmetros

• data Stream: Objeto 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

DataType

Classe StreamResult

public sealed class StreamResult : IOperationResult

Herança

object ← StreamResult

Implementa

• IOperationResult

Membros Herdados

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

Propriedades

Data

Obtém os dados brutos.

public object Data { get; }

Valor da Propriedade

object

IsFile

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

public bool IsFile { get; }

Valor da Propriedade

bool

IsStream

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

public bool IsStream { get; }

Valor da Propriedade

bool

IsString

Indica se o resultado é uma string.

public bool IsString { get; }

Valor da Propriedade

bool

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

public Stream ToStream()

Retorna

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

Classe StringResult

public sealed class StringResult : IOperationResult

Herança

object ← StringResult

Implementa

• IOperationResult

Membros Herdados

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

Propriedades

Data

Obtém os dados brutos.

public object Data { get; }

Valor da Propriedade

object

IsFile

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

public bool IsFile { get; }

Valor da Propriedade

bool

IsStream

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

public bool IsStream { get; }

Valor da Propriedade

bool

IsString

Indica se o resultado é uma string.

public bool IsString { get; }

Valor da Propriedade

bool

Text

Retorna a representação em string do resultado.

public string Text { get; }

Valor da Propriedade

string

Métodos

ToFile()

Tenta converter o resultado em um arquivo.

public string ToFile()

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

Classe TableBuilder

public class TableBuilder

Herança

object ← TableBuilder

Derivados

• TableRowBuilder

Membros Herdados

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

Métodos

AddRow()

Adicionar nova linha à tabela.

public virtual TableRowBuilder AddRow()

Retorna

TableRowBuilder : Instância do atual Documentize.TableRowBuilder.

AddTable()

Adicionar nova tabela ao documento.

public TableBuilder AddTable()

Retorna

TableBuilder : Instância do atual Documentize.TableBuilder.

InsertPageAfter(int)

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

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

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.

Classe TableCellBuilder

public class TableCellBuilder : TableRowBuilder

Herança

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

Membros Herdados

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

Métodos

AddCell()

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 Parágrafos.

Retorna

TableCellBuilder : Instância do atual Documentize.TableCellBuilder.

Classe TableGenerator

public sealed class TableGenerator

Herança

object ← TableGenerator

Membros Herdados

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

Exemplos

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

// cria TableGenerator
var plugin = new TableGenerator();
// cria objeto TableOptions para definir as instruções
TableOptions opt = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Nome")
            .AddCell().AddParagraph("Idade")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// adiciona caminho do arquivo de entrada
opt.AddInput(new FileDataSource(inputPath1));
// define o caminho do arquivo de saída
opt.AddOutput(new FileDataSource(outputPath));
// realiza o processo
plugin.Process(opt);

Construtores

TableGenerator()

public TableGenerator()

Métodos

Process(TableOptions)

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

public ResultContainer Process(TableOptions options)

Parâmetros

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

Retorna

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

Classe TableOptions

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

Herança

object ← PluginBaseOptions ← TableOptions

Implementa

• IPluginOptions

Membros Herdados

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

Construtores

TableOptions()

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

public TableOptions()

Métodos

AddTable()

Adicionando tabela ao documento.

public TableBuilder AddTable()

Retorna

TableBuilder : Nova instância de Documentize.TableBuilder.

Create()

Cria uma instância de Documentize.TableOptions.

public static TableOptions Create()

Retorna

TableOptions : Nova instância de Documentize.TableOptions.

InsertPageAfter(int)

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

public TableOptions InsertPageAfter(int page)

Parâmetros

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

Retorna

TableOptions : Instância da atual 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 para inserir tabela após.

Retorna

TableOptions : Instância da atual Documentize.TableOptions.

Classe TableRowBuilder

public class TableRowBuilder : TableBuilder  

Herança

object ←
TableBuilder ←
TableRowBuilder

Derivados

• TableCellBuilder

Membros Herdados

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

Métodos

AddCell()

Adicionar célula à linha da tabela.

public virtual TableCellBuilder AddCell()  

Retorna

TableCellBuilder : Instância do Documentize.TableCellBuilder criado.

AddRow()

Sobrescrevendo AddRow.

public override TableRowBuilder AddRow()  

Retorna

TableRowBuilder : Instância do Documentize.TableRowBuilder atual.

Classe TextExtractor

public class TextExtractor : PdfExtractor, IDisposable  

Herança

object ←
PdfExtractor ←
TextExtractor

Implementa

• IDisposable

Membros Herdados

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

Exemplos

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

// criar objeto TextExtractor para extrair texto em conteúdos PDF  
using (var plugin = new TextExtractor())  
{  
    // criar TextExtractorOptions  
    var opt = new TextExtractorOptions();  
  
    // adicionar caminho do arquivo de entrada  
    opt.AddInput(new FileDataSource(inputPath));  
  
    // realizar o processo de extração  
    var resultContainer = plugin.Process(opt);  
  
    // obter o texto extraído do objeto ResultContainer  
    var textExtracted = resultContainer.ResultCollection[0].ToString();  
}  

Construtores

TextExtractor()

public TextExtractor()  

Classe TextExtractorOptions

public sealed class TextExtractorOptions : PdfExtractorOptions, IPluginOptions

Herança

object ← PdfExtractorOptions ← TextExtractorOptions

Implementa

• IPluginOptions

Membros Herdados

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

Exemplos

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

// criar objeto TextExtractor para extrair conteúdos PDF
using (TextExtractor extractor = new TextExtractor())
{
    // criar objeto TextExtractorOptions para definir TextFormattingMode (Puro, ou Cru - padrão)
    extractorOptions = new TextExtractorOptions(TextExtractorOptions.TextFormattingMode.Pure);

    // adicionar caminho do arquivo de entrada às fontes de dados
    extractorOptions.AddInput(new FileDataSource(inputPath));

    // realizar processo de extração
    ResultContainer resultContainer = extractor.Process(extractorOptions);

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

Observações

O objeto Documentize.TextExtractorOptions é usado para definir Documentize.TextExtractorOptions.TextFormattingMode e outras opções para a operação de extração de texto. Além disso, herda funções para adicionar dados (arquivos, fluxos) representando documentos PDF de entrada.

Construtores

TextExtractorOptions(TextFormattingMode)

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

public TextExtractorOptions(TextExtractorOptions.TextFormattingMode formattingMode)

Parâmetros

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

TextExtractorOptions()

Inicializa uma nova instância do objeto Documentize.TextExtractorOptions com o modo de formatação de texto ‘Cru’ (padrão).

public TextExtractorOptions()

Propriedades

FormattingMode

Obtém o modo de formatação.

public TextExtractorOptions.TextFormattingMode FormattingMode { get; }

Valor da Propriedade

TextExtractorOptions.TextFormattingMode

OperationName

Retorna o nome da operação.

public override string OperationName { get; }

Valor da Propriedade

string

Classe TiffConverter

public sealed class TiffConverter

Herança

object ← TiffConverter

Membros Herdados

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

Exemplos

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

// criar TiffConverter
var plugin = new TiffConverter();
// criar objeto PdfToTiffOptions para definir instruções
var opt = new PdfToTiffOptions();
// adicionar caminho do arquivo de entrada
opt.AddInput(new FileDataSource(inputPath));
// definir caminho do arquivo de saída
opt.AddOutput(new DirectoryDataSource(outputPath));
// realizar o processo
plugin.Process(opt);

Construtores

TiffConverter()

public TiffConverter()

Métodos

Process(PdfToTiffOptions)

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

public ResultContainer Process(PdfToTiffOptions options)

Parâmetros

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

Retorna

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

Classe XlsConverter

public sealed class XlsConverter