Class Document
Namespace: Aspose.Pdf
Assembly: Aspose.PDF.dll
Classe que representa um documento PDF
public sealed class Document : IDisposableHerança
Implementa
Membros Herdados
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Construtores
Document(Stream)
Inicializa uma nova instância de Document a partir do fluxo input.
public Document(Stream input)Parâmetros
input Stream
Fluxo com o documento pdf.
Document(Stream, string, bool)
Inicializa uma nova instância de Document a partir do fluxo input.
public Document(Stream input, string password, bool isManagedStream)Parâmetros
input Stream
Fluxo com o documento pdf.
password string
Senha de usuário ou proprietário.
isManagedStream bool
se definido como true, o fluxo interno é fechado antes da saída; caso contrário, não é.
Document(Stream, bool)
Inicializa uma nova instância de Document a partir do fluxo input.
public Document(Stream input, bool isManagedStream)Parâmetros
input Stream
Fluxo com o documento pdf.
isManagedStream bool
se definido como true, o fluxo interno é fechado antes da saída; caso contrário, não é.
Document(string)
Apenas inicializa o Document usando filename. O mesmo que Aspose.Pdf.Document.#ctor(System.IO.Stream).
public Document(string filename)Parâmetros
filename string
O nome do arquivo do documento pdf.
Document(Stream, string)
Inicializa uma nova instância de Document a partir do fluxo input.
public Document(Stream input, string password)Parâmetros
input Stream
Objeto de fluxo de entrada, o pdf está protegido por senha.
password string
Senha de usuário ou proprietário.
Document()
Inicializa um documento vazio.
public Document()Document(string, string)
Inicializa uma nova instância da classe Aspose.Pdf.Document para trabalhar com documentos criptografados.
public Document(string filename, string password)Parâmetros
filename string
Nome do arquivo do documento.
password string
Senha de usuário ou proprietário.
Document(string, string, bool)
Inicializa uma nova instância da classe Aspose.Pdf.Document para trabalhar com documentos criptografados.
public Document(string filename, string password, bool isManagedStream)Parâmetros
filename string
Nome do arquivo do documento.
password string
Senha de usuário ou proprietário.
isManagedStream bool
se definido como true, o fluxo interno é fechado antes da saída; caso contrário, não é.
Document(string, LoadOptions)
Abre um documento existente de um arquivo fornecendo as opções de conversão necessárias para obter o documento pdf.
public Document(string filename, LoadOptions options)Parâmetros
filename string
Arquivo de entrada para converter em documento pdf.
options LoadOptions
Representa propriedades para converter filename em documento pdf.
Document(Stream, LoadOptions)
Abre um documento existente de um fluxo fornecendo as opções de conversão necessárias para obter o documento pdf.
public Document(Stream input, LoadOptions options)Parâmetros
input Stream
Fluxo de entrada para converter em documento pdf.
options LoadOptions
Representa propriedades para converter input em documento pdf.
Campos
DefaultNodesNumInSubtrees
public const byte DefaultNodesNumInSubtrees = 10Valor do Campo
Propriedades
Actions
Obtém as ações do documento. Esta propriedade é uma instância da classe DocumentActions que permite obter definir ações BeforClosing, BeforSaving, etc.
public DocumentActionCollection Actions { get; }Valor da Propriedade
DocumentActionCollection
Exemplos
Este exemplo demonstra como obter a ação após abrir o documento:
Aspose.Pdf.Document document = new Aspose.Pdf.Document("d:\\work\\aspose\\aspose.pdf.kit.net.new\\trunk\\testdata\\Aspose.Pdf\\PdfWithOpenAction.pdf");
Aspose.Pdf.Annotations.DocumentActionCollection actions = document.Actions;
Aspose.Pdf.Annotations.PdfAction afterSavingAction = actions.AfterSaving;AllowReusePageContent
Permite mesclar conteúdos de página para otimizar o tamanho do documento. Se usado, páginas diferentes, mas duplicadas podem referenciar o mesmo objeto de conteúdo. Observe que este modo pode causar efeitos colaterais, como a alteração do conteúdo da página quando outra página é alterada.
public bool AllowReusePageContent { get; set; }Valor da Propriedade
Background
Obtém ou define a cor de fundo do documento.
public Color Background { get; set; }Valor da Propriedade
Color
CenterWindow
Obtém ou define a flag que especifica se a posição da janela do documento será centralizada na tela.
public bool CenterWindow { get; set; }Valor da Propriedade
Exemplos
O exemplo demonstra como obter a flag CenterWindow:
Document document = new Document("sample.pdf");
bool value = document.CenterWindow;Collection
Obtém a coleção do documento.
public Collection Collection { get; set; }Valor da Propriedade
Collection
CryptoAlgorithm
Obtém as configurações de segurança se o documento estiver criptografado. Se o documento não estiver criptografado, a exceção correspondente será levantada no .net 1.1 ou CryptoAlgorithm será nulo para outras versões do .net.
public CryptoAlgorithm? CryptoAlgorithm { get; }Valor da Propriedade
CryptoAlgorithm?
Destinations
Obtém a coleção de destinos. Obsoleto. Por favor, use NamedDestinations.
public DestinationCollection Destinations { get; }Valor da Propriedade
DestinationCollection
Direction
Obtém ou define a ordem de leitura do texto: L2R (da esquerda para a direita) ou R2L (da direita para a esquerda).
public Direction Direction { get; set; }Valor da Propriedade
Direction
DisableFontLicenseVerifications
Muitas operações com fontes não podem ser executadas se essas operações forem proibidas pela licença dessa fonte. Por exemplo, algumas fontes não podem ser incorporadas em documentos PDF se as regras de licença desativarem a incorporação para essa fonte. Essa flag é usada para desativar quaisquer restrições de licença para todas as fontes no documento PDF atual. Tenha cuidado ao usar essa flag. Quando ela é definida, significa que a pessoa que define essa flag, assume toda a responsabilidade por possíveis violações de licença/lei. Portanto, assume isso por conta e risco. Recomenda-se fortemente usar essa flag apenas quando você estiver totalmente confiante de que não está infringindo a lei de direitos autorais. Por padrão, falso.
public bool DisableFontLicenseVerifications { get; set; }Valor da Propriedade
DisplayDocTitle
Obtém ou define a flag que especifica se a barra de título da janela do documento deve exibir o título do documento.
public bool DisplayDocTitle { get; set; }Valor da Propriedade
Exemplos
O exemplo demonstra como obter a flag DisplayDocTitle:
Document document = new Document("sample.pdf");
bool value = document.DisplayDocTitle;Duplex
Obtém ou define a opção de manuseio do modo duplex de impressão a ser usada ao imprimir o arquivo a partir da caixa de diálogo de impressão.
public PrintDuplex Duplex { get; set; }Valor da Propriedade
PrintDuplex
EmbedStandardFonts
Propriedade que declara que o documento deve incorporar todas as fontes padrão Type1 que têm a flag IsEmbedded definida como verdadeira. Todas as fontes PDF podem ser incorporadas no documento simplesmente definindo a flag IsEmbedded como verdadeira, mas as fontes padrão Type1 do PDF são uma exceção a essa regra. A incorporação de fontes padrão Type1 requer muito tempo, portanto, para incorporar essas fontes, é necessário não apenas definir a flag IsEmbedded como verdadeira para a fonte especificada, mas também definir uma flag adicional no nível do documento - EmbedStandardFonts = true; Essa propriedade pode ser definida apenas uma vez para todas as fontes. Por padrão, falso.
public bool EmbedStandardFonts { get; set; }Valor da Propriedade
EmbeddedFiles
Obtém a coleção de arquivos incorporados ao documento.
public EmbeddedFileCollection EmbeddedFiles { get; }Valor da Propriedade
EmbeddedFileCollection
EnableObjectUnload
Obtém ou define a flag que permite que o documento seja descarregado parcialmente da memória. Isso permite reduzir o uso de memória, mas pode ter um efeito negativo no desempenho.
public bool EnableObjectUnload { get; set; }Valor da Propriedade
EnableSignatureSanitization
Obtém ou define a flag para gerenciar a sanitização dos campos de assinatura. Habilitado por padrão.
public bool EnableSignatureSanitization { get; set; }Valor da Propriedade
FileName
Nome do arquivo PDF que causou este documento
public string FileName { get; }Valor da Propriedade
FitWindow
Obtém ou define a flag que especifica se a janela do documento deve ser redimensionada para se ajustar à primeira página exibida.
public bool FitWindow { get; set; }Valor da Propriedade
Exemplos
O exemplo abaixo demonstra como obter a flag FitWindow:
Document document = new Document("sample.pdf");
bool value = document.FitWindow;FontUtilities
Instância de IDocumentFontUtilities
public Document.IDocumentFontUtilities FontUtilities { get; }Valor da Propriedade
Document.IDocumentFontUtilities
Form
Obtém o Acro Form do documento.
public Form Form { get; }Valor da Propriedade
Form
HandleSignatureChange
Lança uma Exceção se o documento for salvo com alterações e tiver assinatura
public bool HandleSignatureChange { get; set; }Valor da Propriedade
HideMenubar
Obtém ou define a flag que especifica se a barra de menu deve ser oculta quando o documento estiver ativo.
public bool HideMenubar { get; set; }Valor da Propriedade
Exemplos
O exemplo demonstra como obter a flag HideMenubar:
Document document = new Document("sample.pdf");
bool value = document.HideMenubar;HideToolBar
Obtém ou define a flag que especifica se a barra de ferramentas deve ser oculta quando o documento estiver ativo.
public bool HideToolBar { get; set; }Valor da Propriedade
Exemplos
O exemplo demonstra como obter a flag HideToolBar:
Document document = new Document("sample.pdf");
bool value = document.HideToolBar;HideWindowUI
Obtém ou define a flag que especifica se os elementos da interface do usuário devem ser ocultados quando o documento estiver ativo.
public bool HideWindowUI { get; set; }Valor da Propriedade
Exemplos
O exemplo demonstra como obter a flag HideWindowUI:
Document document = new Document("sample.pdf");
bool value = document.HideWindowUI;Id
Obtém o ID.
public Id Id { get; }Valor da Propriedade
Id
IgnoreCorruptedObjects
Obtém ou define a flag de ignorar erros em arquivos de origem. Quando páginas do documento de origem são copiadas para o documento de destino, o processo de cópia é interrompido com exceção se alguns objetos nos arquivos de origem estiverem corrompidos quando essa flag for falsa. exemplo: dest.Pages.Add(src.Pages); Se essa flag for definida como verdadeira, os objetos corrompidos serão substituídos por valores vazios. Por padrão: verdadeiro.
public bool IgnoreCorruptedObjects { get; set; }Valor da Propriedade
Info
Obtém as informações do documento.
public DocumentInfo Info { get; }Valor da Propriedade
DocumentInfo
IsEncrypted
Obtém o status de criptografia do documento. Verdadeiro se o documento estiver criptografado.
public bool IsEncrypted { get; }Valor da Propriedade
IsLicensed
Obtém o estado licenciado do sistema. Retorna verdadeiro se o sistema estiver funcionando no modo licenciado e falso caso contrário.
public static bool IsLicensed { get; }Valor da Propriedade
IsLinearized
Obtém ou define um valor que indica se o documento está linearizado.
public bool IsLinearized { get; set; }Valor da Propriedade
IsPdfUaCompliant
Obtém se o documento é compatível com pdfua.
public bool IsPdfUaCompliant { get; }Valor da Propriedade
IsPdfaCompliant
Obtém se o documento é compatível com pdfa.
public bool IsPdfaCompliant { get; }Valor da Propriedade
IsXrefGapsAllowed
Obtém ou define se o documento permite lacunas de xref.
public bool IsXrefGapsAllowed { get; set; }Valor da Propriedade
JavaScript
Coleção de JavaScript de nível de documento.
public JavaScriptCollection JavaScript { get; }Valor da Propriedade
JavaScriptCollection
LogicalStructure
Obtém a estrutura lógica do documento.
public RootElement LogicalStructure { get; }Valor da Propriedade
RootElement
Metadata
Metadados do documento. (Um documento PDF pode incluir informações gerais, como o título do documento, autor e datas de criação e modificação. Essas informações globais sobre o documento (em oposição ao seu conteúdo ou estrutura) são chamadas de metadados e têm como objetivo ajudar na catalogação e na busca de documentos em bancos de dados externos.)
public Metadata Metadata { get; }Valor da Propriedade
Metadata
NamedDestinations
Coleção de Destinos Nomeados no documento.
public NamedDestinationCollection NamedDestinations { get; }Valor da Propriedade
NamedDestinationCollection
NonFullScreenPageMode
Obtém ou define o modo de página, especificando como exibir o documento ao sair do modo de tela cheia.
public PageMode NonFullScreenPageMode { get; set; }Valor da Propriedade
PageMode
OpenAction
Obtém ou define a ação realizada ao abrir o documento.
public IAppointment OpenAction { get; set; }Valor da Propriedade
IAppointment
Exemplos
O exemplo demonstra como obter a flag CenterWindow:
Document document = new Document("sample.pdf");
IAppointment value = document.OpenAction;OptimizeSize
Obtém ou define a flag de otimização. Quando páginas são adicionadas ao documento, fluxos de recursos iguais no arquivo resultante são mesclados em um objeto PDF se essa flag estiver definida. Isso permite reduzir o tamanho do arquivo resultante, mas pode causar uma execução mais lenta e maiores requisitos de memória. Valor padrão: falso.
public bool OptimizeSize { get; set; }Valor da Propriedade
Outlines
Obtém os contornos do documento.
public OutlineCollection Outlines { get; }Valor da Propriedade
OutlineCollection
OutputIntents
Obtém a coleção de Intenções de Saída no documento.
public OutputIntents OutputIntents { get; }Valor da Propriedade
OutputIntents
PageInfo
Obtém ou define as informações da página. (apenas para gerador, não preenchido ao ler o documento)
public PageInfo PageInfo { get; set; }Valor da Propriedade
PageInfo
PageLabels
Obtém os rótulos das páginas no documento.
public PageLabelCollection PageLabels { get; }Valor da Propriedade
PageLabelCollection
PageLayout
Obtém ou define o layout da página que deve ser usado quando o documento for aberto.
public PageLayout PageLayout { get; set; }Valor da Propriedade
PageLayout
PageMode
Obtém ou define o modo de página, especificando como o documento deve ser exibido quando aberto.
public PageMode PageMode { get; set; }Valor da Propriedade
PageMode
Pages
Obtém ou define a coleção de páginas do documento. Observe que as páginas são numeradas a partir de 1 na coleção.
public PageCollection Pages { get; }Valor da Propriedade
PageCollection
Exemplos
O exemplo abaixo demonstra como operar com as páginas do documento: Como obter o número de páginas e como obter o retângulo da página inicial do documento.
Aspose.Pdf.Document document = new Aspose.Pdf.Document("sample.pdf");
Aspose.Pdf.PageCollection pages = document.Pages;
System.Console.WriteLine("O documento contém " + pages.Count);
Page page = pages[1];
Rectangle rect = page.Rect;PdfFormat
Obtém o formato PDF
public PdfFormat PdfFormat { get; }Valor da Propriedade
PdfFormat
Permissions
Obtém as permissões do documento.
public int Permissions { get; }Valor da Propriedade
PickTrayByPdfSize
Obtém ou define uma flag que especifica se o tamanho da página PDF deve ser usado para selecionar a bandeja de papel de entrada.
public bool PickTrayByPdfSize { get; set; }Valor da Propriedade
PrintScaling
Obtém ou define a opção de escalonamento de página que deve ser selecionada quando uma caixa de diálogo de impressão é exibida para este documento.
public PrintScaling PrintScaling { get; set; }Valor da Propriedade
PrintScaling
TaggedContent
Obtém acesso ao conteúdo TaggedPdf.
public ITaggedContent TaggedContent { get; }Valor da Propriedade
ITaggedContent
Exemplos
O exemplo demonstra como usar o conteúdo marcado para criar um novo documento com cabeçalho, parágrafos e imagens.
// Cria um novo documento
Document document = new Document();
// Obtém o conteúdo marcado
ITaggedContent taggedContent = document.TaggedContent;
// Define o idioma para o documento
taggedContent.SetLanguage("en-US");
// Define o título para o documento PDF
taggedContent.SetTitle("Documento de exemplo");
// Criando e adicionando Seção
SectElement sect = taggedContent.CreateSectElement();
taggedContent.RootElement.AppendChild(sect);
// Cria Cabeçalho
HeaderElement h1 = taggedContent.CreateHeaderElement(1);
h1.SetText("O Cabeçalho");
sect.AppendChild(h1);
// Cria parágrafo
ParagraphElement p = taggedContent.CreateParagraphElement();
p.SetTag("Parágrafo");
p.SetText("O texto do parágrafo.");
sect.AppendChild(p);
// Cria ilustração
IllustrationElement figure1 = taggedContent.CreateFigureElement();
sect.AppendChild(figure1);
figure1.AlternativeText = "Figura 1";
figure1.Title = "Imagem 1";
figure1.SetTag("Fig");
figure1.SetImage("caminho/da/imagem.jpg");
// Salva o documento
document.Save("exemplo.pdf");Version
Obtém uma versão do Pdf do cabeçalho do arquivo Pdf.
public string Version { get; }Valor da Propriedade
Métodos
BindXml(string)
Vincula xml ao documento
public void BindXml(string file)Parâmetros
file string
O arquivo xml
BindXml(string, string)
Vincula xml/xsl ao documento
public void BindXml(string xmlFile, string xslFile)Parâmetros
xmlFile string
O arquivo xml.
xslFile string
O arquivo xsl se XSLT for usado.
BindXml(Stream, Stream)
Vincula xml/xsl ao documento
public void BindXml(Stream xmlStream, Stream xslStream)Parâmetros
xmlStream Stream
O fluxo xml.
xslStream Stream
O fluxo xsl se XSLT for usado.
BindXml(Stream, Stream, XmlReaderSettings)
Vincula xml/xsl ao documento
public void BindXml(Stream xmlStream, Stream xslStream, XmlReaderSettings settings)Parâmetros
xmlStream Stream
O fluxo xml.
xslStream Stream
O fluxo xsl se XSLT for usado.
settings XmlReaderSettings
As configurações do leitor xml.
BindXml(Stream)
Vincula xml ao documento
public void BindXml(Stream stream)Parâmetros
stream Stream
O fluxo xml.
ChangePasswords(string, string, string)
Altera as senhas do documento. Esta ação pode ser realizada apenas usando a senha do proprietário.
public void ChangePasswords(string ownerPassword, string newUserPassword, string newOwnerPassword)Parâmetros
ownerPassword string
Senha do proprietário.
newUserPassword string
Nova senha de usuário.
newOwnerPassword string
Nova senha do proprietário.
Check(bool)
Valida o documento.
public bool Check(bool doRepair)Parâmetros
doRepair bool
Se verdadeiro, os problemas encontrados serão reparados.
Retorna
Verdadeiro - se o documento foi reparado; caso contrário, falso.
Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Converte o documento e salva os erros no arquivo especificado.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)Parâmetros
outputLogFileName string
Caminho para o arquivo onde os comentários serão armazenados.
format PdfFormat
O formato pdf.
action ConvertErrorAction
Ação para objetos que não podem ser convertidos.
transparencyAction ConvertTransparencyAction
Ação para objetos de imagem mascarados.
Retorna
O resultado da operação.
Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Converte o documento e salva os erros no arquivo especificado.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)Parâmetros
outputLogStream Stream
Fluxo onde os comentários serão armazenados.
format PdfFormat
O formato pdf.
action ConvertErrorAction
Ação para objetos que não podem ser convertidos.
transparencyAction ConvertTransparencyAction
Ação para objetos de imagem mascarados.
Retorna
O resultado da operação.
Convert(string, PdfFormat, ConvertErrorAction)
Converte o documento e salva os erros no arquivo especificado.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action)Parâmetros
outputLogFileName string
Caminho para o arquivo onde os comentários serão armazenados.
format PdfFormat
O formato pdf.
action ConvertErrorAction
Ação para objetos que não podem ser convertidos.
Retorna
O resultado da operação.
Convert(PdfFormatConversionOptions)
Converte o documento usando as opções de conversão especificadas.
public bool Convert(PdfFormatConversionOptions options)Parâmetros
options PdfFormatConversionOptions
conjunto de opções para converter o documento PDF.
Retorna
O resultado da operação.
Convert(CallBackGetHocrWithPage, bool)
Reconhece imagens dentro do documento e adiciona strings hocr sobre elas.
public bool Convert(Document.CallBackGetHocrWithPage callback, bool flattenImages = false)Parâmetros
callback Document.CallBackGetHocrWithPage
Ação para imagens que serão processadas pelo reconhecimento hocr.
flattenImages bool
O texto nas imagens pdf pode ser pintado usando a mecânica de máscaras, nesse caso as imagens devem ser achatadas.
Retorna
O resultado da operação. Se não houver imagens no documento, retorna falso.
Convert(CallBackGetHocr, bool)
Reconhece imagens dentro do documento e adiciona strings hocr sobre elas.
public bool Convert(Document.CallBackGetHocr callback, bool flattenImages = false)Parâmetros
callback Document.CallBackGetHocr
Ação para imagens que serão processadas pelo reconhecimento hocr.
flattenImages bool
O texto nas imagens pdf pode ser pintado usando a mecânica de máscaras, nesse caso as imagens devem ser achatadas.
Retorna
O resultado da operação. Se não houver imagens no documento, retorna falso.
Convert(Stream, PdfFormat, ConvertErrorAction)
Converte o documento e salva os erros no fluxo especificado.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action)Parâmetros
outputLogStream Stream
Fluxo onde os comentários serão armazenados.
format PdfFormat
Formato pdf.
action ConvertErrorAction
Ação para objetos que não podem ser convertidos.
Retorna
O resultado da operação.
Convert(Fixup, Stream, bool, object[])
Converte o documento aplicando o Fixup.
public bool Convert(Fixup fixup, Stream outputLog, bool onlyValidation = false, object[] parameters = null)Parâmetros
fixup Fixup
O tipo de Fixup.
outputLog Stream
O log do processo.
onlyValidation bool
Apenas validação do documento.
parameters object[]
Propriedades para Fixup que não podem ser definidas.
Retorna
O resultado da operação.
Convert(Fixup, string, bool, object[])
Converte o documento aplicando o Fixup.
public bool Convert(Fixup fixup, string outputLog, bool onlyValidation = false, object[] parameters = null)Parâmetros
fixup Fixup
O tipo de Fixup.
outputLog string
O log do processo.
onlyValidation bool
Apenas validação do documento.
parameters object[]
Propriedades para Fixup que não podem ser definidas.
Retorna
O resultado da operação.
Convert(string, LoadOptions, string, SaveOptions)
Converte o arquivo de origem no formato de origem para o arquivo de destino no formato de destino.
public static void Convert(string srcFileName, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)Parâmetros
srcFileName string
O nome do arquivo de origem.
loadOptions LoadOptions
O formato do arquivo de origem.
dstFileName string
O nome do arquivo de destino.
saveOptions SaveOptions
O formato do arquivo de destino.
Convert(Stream, LoadOptions, string, SaveOptions)
Converte o fluxo no formato de origem para o arquivo de destino no formato de destino.
public static void Convert(Stream srcStream, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)Parâmetros
srcStream Stream
O fluxo de origem.
loadOptions LoadOptions
O formato do fluxo de origem.
dstFileName string
O nome do arquivo de destino.
saveOptions SaveOptions
O formato do arquivo de destino.
Convert(string, LoadOptions, Stream, SaveOptions)
Converte o arquivo de origem no formato de origem para o fluxo no formato de destino.
public static void Convert(string srcFileName, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)Parâmetros
srcFileName string
O nome do arquivo de origem.
loadOptions LoadOptions
O formato do arquivo de origem.
dstStream Stream
O fluxo de destino.
saveOptions SaveOptions
O formato do fluxo de destino.
Convert(Stream, LoadOptions, Stream, SaveOptions)
Converte o fluxo no formato de origem para o fluxo no formato de destino.
public static void Convert(Stream srcStream, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)Parâmetros
srcStream Stream
O fluxo de origem.
loadOptions LoadOptions
O formato do fluxo de origem.
dstStream Stream
O fluxo de destino.
saveOptions SaveOptions
O formato do arquivo de destino.
ConvertPageToPNGMemoryStream(Page)
Converte a página para PNG para DSR, OMR, fluxo de imagem OCR.
public MemoryStream ConvertPageToPNGMemoryStream(Page page)Parâmetros
page Page
Página a ser convertida.
Retorna
Fluxo de imagem.
Decrypt()
Descriptografa o documento. Chame então Save para obter a versão descriptografada do documento.
public void Decrypt()Dispose()
Fecha todos os recursos usados por este documento.
public void Dispose()Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool)
Criptografa o documento. Chame então Save para obter a versão criptografada do documento.
public void Encrypt(string userPassword, string ownerPassword, DocumentPrivilege privileges, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)Parâmetros
userPassword string
Senha do usuário.
ownerPassword string
Senha do proprietário.
privileges DocumentPrivilege
Permissões do documento, veja Aspose.Pdf.Document.Permissions para detalhes.
cryptoAlgorithm CryptoAlgorithm
Algoritmo criptográfico, veja Aspose.Pdf.Document.CryptoAlgorithm para detalhes.
usePdf20 bool
Suporte para a revisão 6 (Extensão 8).
Encrypt(string, string, Permissions, CryptoAlgorithm)
Criptografa o documento. Chame então Save para obter a versão criptografada do documento.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm)Parâmetros
userPassword string
Senha do usuário.
ownerPassword string
Senha do proprietário.
permissions Permissions
Permissões do documento, veja Aspose.Pdf.Document.Permissions para detalhes.
cryptoAlgorithm CryptoAlgorithm
Algoritmo criptográfico, veja Aspose.Pdf.Document.CryptoAlgorithm para detalhes.
Encrypt(string, string, Permissions, CryptoAlgorithm, bool)
Criptografa o documento. Chame então Save para obter a versão criptografada do documento.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)Parâmetros
userPassword string
Senha do usuário.
ownerPassword string
Senha do proprietário.
permissions Permissions
Permissões do documento, veja Aspose.Pdf.Document.Permissions para detalhes.
cryptoAlgorithm CryptoAlgorithm
Algoritmo criptográfico, veja Aspose.Pdf.Document.CryptoAlgorithm para detalhes.
usePdf20 bool
Suporte para a revisão 6 (Extensão 8).
ExportAnnotationsToXfdf(string)
Exporta todas as anotações do documento para um arquivo XFDF
public void ExportAnnotationsToXfdf(string fileName)Parâmetros
fileName string
Nome do arquivo XFDF
ExportAnnotationsToXfdf(Stream)
Exporta todas as anotações do documento para o fluxo.
public void ExportAnnotationsToXfdf(Stream stream)Parâmetros
stream Stream
Fluxo onde armazenar XFDF.
Flatten()
Remove todos os campos do documento e coloca seus valores no lugar.
public void Flatten()Flatten(FlattenSettings)
Remove todos os campos (e anotações) do documento e coloca seus valores no lugar.
public void Flatten(Form.FlattenSettings flattenSettings)Parâmetros
flattenSettings Form.FlattenSettings
Configurações para o processo de achatamento.
FlattenTransparency()
Substitui o conteúdo transparente por gráficos raster e vetoriais não transparentes.
public void FlattenTransparency()FreeMemory()
Limpa a memória
public void FreeMemory()GetCatalogValue(string)
Retorna o valor do item do dicionário de catálogo.
public object GetCatalogValue(string key)Parâmetros
key string
A chave do item.
Retorna
Valor do item - se a chave foi encontrada com sucesso; caso contrário, nulo.
GetObjectById(string)
Obtém um objeto com o ID especificado no documento.
public object GetObjectById(string id)Parâmetros
id string
O id do objeto.
Retorna
O objeto com o id especificado. Nulo se o id não for encontrado.
GetXmpMetadata(Stream)
Obtém os metadados XMP do documento.
public void GetXmpMetadata(Stream stream)Parâmetros
stream Stream
Fluxo onde os metadados serão armazenados.
HasIncrementalUpdate()
Verifica se o documento PDF atual foi salvo com atualizações incrementais.
public bool HasIncrementalUpdate()Retorna
true se o documento PDF tiver atualizações incrementais; caso contrário, false.
ImportAnnotationsFromXfdf(string)
Importa anotações do arquivo XFDF para o documento.
public void ImportAnnotationsFromXfdf(string fileName)Parâmetros
fileName string
Nome do arquivo XFDF
ImportAnnotationsFromXfdf(Stream)
Importa anotações do fluxo para o documento.
public void ImportAnnotationsFromXfdf(Stream stream)Parâmetros
stream Stream
Fluxo que contém dados XFDF.
LoadFrom(string, LoadOptions)
Carrega um arquivo, convertendo-o para PDF.
public void LoadFrom(string filename, LoadOptions options)Parâmetros
filename string
O caminho para o arquivo a ser aberto.
options LoadOptions
As opções de carregamento.
Exceções
PdfException
Se o arquivo não puder ser carregado.
Se o arquivo não for encontrado.
Merge(MergeOptions, params Document[])
Mescla documentos.
public void Merge(Document.MergeOptions mergeOptions, params Document[] documents)Parâmetros
mergeOptions Document.MergeOptions
As opções de mesclagem.
documents Document[]
Os documentos a serem mesclados.
Merge(MergeOptions, params string[])
Mescla documentos.
public void Merge(Document.MergeOptions mergeOptions, params string[] files)Parâmetros
mergeOptions Document.MergeOptions
As opções de mesclagem.
files string[]
Os arquivos pdf a serem mesclados.
Merge(params Document[])
Mescla documentos.
public void Merge(params Document[] documents)Parâmetros
documents Document[]
Os documentos a serem mesclados.
Merge(params string[])
Mescla arquivos pdf.
public void Merge(params string[] files)Parâmetros
files string[]
Os arquivos pdf a serem mesclados.
MergeDocuments(MergeOptions, params string[])
Mescla documentos.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params string[] files)Parâmetros
mergeOptions Document.MergeOptions
As opções de mesclagem.
files string[]
Os arquivos pdf a serem mesclados.
Retorna
O documento mesclado.
MergeDocuments(MergeOptions, params Document[])
Mescla documentos.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params Document[] files)Parâmetros
mergeOptions Document.MergeOptions
files Document[]
Os documentos a serem mesclados.
Retorna
O documento mesclado.
MergeDocuments(params string[])
Mescla arquivos pdf.
public static Document MergeDocuments(params string[] files)Parâmetros
files string[]
Os arquivos pdf a serem mesclados.
Retorna
O documento mesclado.
MergeDocuments(params Document[])
Mescla documentos.
public static Document MergeDocuments(params Document[] documents)Parâmetros
documents Document[]
Os documentos a serem mesclados.
Retorna
O documento mesclado.
Optimize()
Lineariza o documento para
- abrir a primeira página o mais rápido possível;
- exibir a próxima página ou seguir um link para a próxima página o mais rápido possível;
- exibir a página de forma incremental à medida que chega quando os dados de uma página são entregues por um canal lento (exibir os dados mais úteis primeiro);
- permitir que a interação do usuário, como seguir um link, seja realizada mesmo antes que a página inteira tenha sido recebida e exibida. Invocar este método não salva realmente o documento. Pelo contrário, o documento é apenas preparado para ter uma estrutura otimizada, chame então Save para obter o documento otimizado.
public void Optimize()OptimizeResources()
Otimize os recursos no documento:
- Recursos que não são usados nas páginas do documento são removidos;
- Recursos iguais são unidos em um objeto;
- Objetos não utilizados são excluídos.
public void OptimizeResources()OptimizeResources(OptimizationOptions)
Otimize os recursos no documento de acordo com a estratégia de otimização definida.
public void OptimizeResources(OptimizationOptions strategy)Parâmetros
strategy OptimizationOptions
Estratégia de otimização.
PageNodesToBalancedTree(byte)
Organiza os nós da árvore de páginas em um documento em uma árvore balanceada. Somente se o documento tiver mais de nodesNumInSubtrees objetos de página, caso contrário, não faz nada. Não chame este método enquanto itera sobre os elementos Pages, pode resultar em resultados imprevisíveis.
public void PageNodesToBalancedTree(byte nodesNumInSubtrees = 10)Parâmetros
nodesNumInSubtrees byte
Número desejado de subnós. O valor padrão é dez.
ProcessParagraphs()
Processa parágrafos para o gerador.
public void ProcessParagraphs()RemoveMetadata()
Remove metadados do documento.
public void RemoveMetadata()RemovePdfUaCompliance()
Remove a conformidade pdfUa do documento.
public void RemovePdfUaCompliance()RemovePdfaCompliance()
Remove a conformidade pdfa do documento.
public void RemovePdfaCompliance()Repair()
Repara o documento quebrado.
public void Repair()Save(Stream)
Armazena o documento no fluxo.
public void Save(Stream output)Parâmetros
output Stream
Fluxo onde o documento deve ser armazenado.
Save(string)
Salva o documento no arquivo especificado.
public void Save(string outputFileName)Parâmetros
outputFileName string
Caminho para o arquivo onde o documento será armazenado.
Save()
Salva o documento de forma incremental (ou seja, usando a técnica de atualização incremental).
public void Save()Observações
Para salvar o documento de forma incremental, devemos abrir o arquivo do documento para gravação. Portanto, o Document deve ser inicializado com um fluxo gravável, como no próximo trecho de código: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // faça algumas alterações e salve o documento de forma incremental doc.Save();
Save(SaveOptions)
Salva o documento com opções de salvamento.
public void Save(SaveOptions options)Parâmetros
options SaveOptions
Opções de salvamento.
Save(string, SaveFormat)
Salva o documento com um novo nome junto com um formato de arquivo.
public void Save(string outputFileName, SaveFormat format)Parâmetros
outputFileName string
Caminho para o arquivo onde o documento será armazenado.
format SaveFormat
Opções de formato.
Save(Stream, SaveFormat)
Salva o documento com um novo nome junto com um formato de arquivo.
public void Save(Stream outputStream, SaveFormat format)Parâmetros
outputStream Stream
Fluxo onde o documento será armazenado.
format SaveFormat
Opções de formato.
Exceções
System.ArgumentException quando Aspose.Pdf.HtmlSaveOptions é passado para um método. Salvar um documento no fluxo html não é suportado. Por favor, use o método salvar para o arquivo.
Save(string, SaveOptions)
Salva o documento com um novo nome definindo suas opções de salvamento.
public void Save(string outputFileName, SaveOptions options)Parâmetros
outputFileName string
Caminho para o arquivo onde o documento será armazenado.
options SaveOptions
Opções de salvamento.
Save(Stream, SaveOptions)
Salva o documento em um fluxo com opções de salvamento.
public void Save(Stream outputStream, SaveOptions options)Parâmetros
outputStream Stream
Fluxo onde o documento será armazenado.
options SaveOptions
Opções de salvamento.
Exceções
System.ArgumentException quando Aspose.Pdf.HtmlSaveOptions é passado para um método. Salvar um documento no fluxo html não é suportado. Por favor, use o método salvar para o arquivo.
SaveAsync(Stream, CancellationToken)
Armazena o documento no fluxo.
public Task SaveAsync(Stream output, CancellationToken cancellationToken)Parâmetros
output Stream
Fluxo onde o documento deve ser armazenado.
cancellationToken CancellationToken
Token de cancelamento.
Retorna
Tarefa assíncrona.
SaveAsync(string, CancellationToken)
Salva o documento no arquivo especificado.
public Task SaveAsync(string outputFileName, CancellationToken cancellationToken)Parâmetros
outputFileName string
Caminho para o arquivo onde o documento será armazenado.
cancellationToken CancellationToken
Token de cancelamento.
Retorna
Tarefa assíncrona.
SaveAsync(CancellationToken)
Salva o documento de forma incremental (ou seja, usando a técnica de atualização incremental).
public Task SaveAsync(CancellationToken cancellationToken)Parâmetros
cancellationToken CancellationToken
Token de cancelamento.
Retorna
Tarefa assíncrona.
Observações
Para salvar o documento de forma incremental, devemos abrir o arquivo do documento para gravação. Portanto, o Document deve ser inicializado com um fluxo gravável, como no próximo trecho de código: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // faça algumas alterações e salve o documento de forma incremental doc.Save();
SaveAsync(SaveOptions, CancellationToken)
Salva o documento com opções de salvamento.
public Task SaveAsync(SaveOptions options, CancellationToken cancellationToken)Parâmetros
options SaveOptions
Opções de salvamento.
cancellationToken CancellationToken
Token de cancelamento.
Retorna
Tarefa assíncrona.
SaveAsync(string, SaveFormat, CancellationToken)
Salva o documento com um novo nome junto com um formato de arquivo.
public Task SaveAsync(string outputFileName, SaveFormat format, CancellationToken cancellationToken)Parâmetros
outputFileName string
Caminho para o arquivo onde o documento será armazenado.
format SaveFormat
Opções de formato.
cancellationToken CancellationToken
Token de cancelamento.
Retorna
Tarefa assíncrona.
SaveAsync(Stream, SaveFormat, CancellationToken)
Salva o documento com um novo nome junto com um formato de arquivo.
public Task SaveAsync(Stream outputStream, SaveFormat format, CancellationToken cancellationToken)Parâmetros
outputStream Stream
Fluxo onde o documento será armazenado.
format SaveFormat
Opções de formato.
cancellationToken CancellationToken
Token de cancelamento.
Retorna
Tarefa assíncrona.
Exceções
System.ArgumentException quando Aspose.Pdf.HtmlSaveOptions é passado para um método. Salvar um documento no fluxo html não é suportado. Por favor, use o método salvar para o arquivo.
SaveAsync(string, SaveOptions, CancellationToken)
Salva o documento com um novo nome definindo suas opções de salvamento.
public Task SaveAsync(string outputFileName, SaveOptions options, CancellationToken cancellationToken)Parâmetros
outputFileName string
Caminho para o arquivo onde o documento será armazenado.
options SaveOptions
Opções de salvamento.
cancellationToken CancellationToken
Token de cancelamento.
Retorna
Tarefa assíncrona.
SaveAsync(Stream, SaveOptions, CancellationToken)
Salva o documento em um fluxo com opções de salvamento.
public Task SaveAsync(Stream outputStream, SaveOptions options, CancellationToken cancellationToken)Parâmetros
outputStream Stream
Fluxo onde o documento será armazenado.
options SaveOptions
Opções de salvamento.
cancellationToken CancellationToken
Token de cancelamento.
Retorna
Tarefa assíncrona.
Exceções
System.ArgumentException quando Aspose.Pdf.HtmlSaveOptions é passado para um método. Salvar um documento no fluxo html não é suportado. Por favor, use o método salvar para o arquivo.
SaveXml(string)
Salva o documento em XML.
public void SaveXml(string file)Parâmetros
file string
O arquivo xml do modelo do documento.
SendTo(DocumentDevice, Stream)
Envia todo o documento para o dispositivo de documento para processamento.
public void SendTo(DocumentDevice device, Stream output)Parâmetros
device DocumentDevice
Dispositivo de documento que é usado para processar o documento.
output Stream
Fluxo de saída que contém os resultados do processamento do documento com o dispositivo dado.
SendTo(DocumentDevice, int, int, Stream)
Envia as certas páginas do documento para o dispositivo de documento para processamento.
public void SendTo(DocumentDevice device, int fromPage, int toPage, Stream output)Parâmetros
device DocumentDevice
Dispositivo de documento que é usado para processar o documento.
fromPage int
A primeira página para processamento.
toPage int
A última página para processamento.
output Stream
Fluxo de saída que contém os resultados do processamento das páginas do documento com o dispositivo dado.
SendTo(DocumentDevice, string)
Envia todo o documento para o dispositivo de documento para processamento.
public void SendTo(DocumentDevice device, string outputFileName)Parâmetros
device DocumentDevice
Dispositivo de documento que é usado para processar o documento.
