APIs de automação codificadas em PDF (pré-visualização)

APIs de automação codificadas para o pacote de atividades de PDF, cobrindo leitura, mesclação, conversão e manipulação de arquivos PDF e XPS.

UiPath.PDF.Activities

API de fluxo de trabalho codificado para ler, mesclar, converter e manipular arquivos PDF e XPS. Essas APIs estão disponíveis ao projetar automações codificadas. Para obter uma introdução a automações codificadas e como projetá-las usando APIs, consulte Automações codificadas.

• Acessador de serviço: pdf (tipo IPdfService)
• Pacote obrigatório: "UiPath.PDF.Activities": "*" nas dependências project.json .

Namespaces importados automaticamente

Os seguintes namespaces estão disponíveis automaticamente em fluxos de trabalho codificados quando o pacote PDF é instalado:

• UiPath.PDF.Activities.Api
• UiPath.PDF
• UiPath.PDF.Activities.PDF.Enums
• UiPath.Platform.ResourceHandling
• System.Net.Mail

Visão geral do serviço

O pdf serviço expõe cada operação como uma chamada de método direta. Não há conexão ou escopo para abrir. A maioria das operações fornece duas formas: uma que leva um caminho de arquivo como um string, e uma que leva um IResource (por exemplo, a saída da atividade Path Exists ou Get Local File or Folder ). Chame métodos no acessador de serviço diretamente:

string text = pdf.ReadPdfText(@"C:\docs\report.pdf");

Os métodos que criam ou transformam um arquivo retornam um ILocalResource apontando para a saída. Quando outputFileName é null, o serviço gera um nome automaticamente. Arquivos protegidos por senha são abertos passando o parâmetro password. O parâmetro range aceita "All" ou intervalos explícitos, como "1-3,5".

Lendo o texto

string ReadPdfText(string fileName, string password = null, string range = "All", bool preserveFormatting = false)

Lê o texto de um arquivo PDF. Defina preserveFormatting como true para manter o layout de texto. Uma sobrecarga aceitando um IResource também está disponível.

string ReadPdfWithOcr(string fileName, IOCRActivity ocrEngine, string range = "All", int degreeOfParallelism = 1, string password = null, ImageDpi imageDpi = ImageDpi.Medium)

Lê o texto de um PDF digitalizado usando o mecanismo de OCR fornecido. Obtenha um mecanismo de OCR do serviço de OCR (por exemplo, IOcrService.GetUiPathDocumentOcr). degreeOfParallelism define quantas páginas são processadas de uma só vez. Apenas no Windows.

string ReadXpsText(string fileName, string range = "All")

Lê o texto de um arquivo XPS. Uma sobrecarga aceitando um IResource também está disponível. Apenas no Windows.

string ReadXpsWithOcr(string fileName, IOCRActivity ocrEngine, string range = "All", int degreeOfParallelism = 1, string password = null)

Lê o texto de um arquivo XPS usando o mecanismo de OCR fornecido. Apenas no Windows.

Operações de página e documento

int GetPdfPageCount(string fileName, string password = null)

Retorna o número de páginas em um arquivo PDF. Uma sobrecarga aceitando um IResource também está disponível.

ILocalResource JoinPdf(string[] fileList, string outputFileName = null)

Mescla vários arquivos PDF em um único PDF, na ordem fornecida. Uma sobrecarga aceitando um IResource[] também está disponível.

ILocalResource ExtractPdfPageRange(string fileName, string range, string password = null, string outputFileName = null)

Extrai um intervalo de páginas (por exemplo, "1-3,5") de um PDF para um novo PDF. Uma sobrecarga aceitando um IResource também está disponível.

ILocalResource ExportPdfPageAsImage(string fileName, int pageNumber, string outputFileName, string password = null, ImageDpi imageDpi = ImageDpi.Medium)

Exporta uma única página (pageNumber com base em 1) como uma imagem. O formato da imagem é inferido da extensão outputFileName. Uma sobrecarga aceitando um IResource também está disponível.

Criação e conversão

ILocalResource CreatePdfFromImages(string[] fileList, string outputFileName = null)

Cria um PDF a partir de uma lista de arquivos de imagem, uma imagem por página. Formatos de entrada compatíveis: PNG, JPG, JPEG, TIF, TIFF, BMP. Uma sobrecarga aceitando um IResource[] também está disponível.

ILocalResource ConvertHtmlToPdf(string html, string outputFileName = null, bool keepBackground = true, ConvertToPdfOptions options = null)

Converte conteúdo HTML em PDF. Defina keepBackground como true para preservar as cores de fundo e os gráficos.

ILocalResource ConvertEmailToPdf(MailMessage email, string outputFileName = null, bool keepBackground = true, ConvertToPdfOptions options = null)

Converte uma mensagem de email em PDF.

ILocalResource ConvertTextToPdf(string text, string outputFileName = null, int fontSize = 12, TextAlignment textAlignment = TextAlignment.Justify, ConvertToPdfOptions options = null)

Converte texto simples em PDF, com tamanho de fonte e alinhamento de texto configuráveis.

Extração de imagens e anexos

IEnumerable<ILocalResource> ExtractImagesFromPdf(string fileName, string password = null, ImageExtension imageExtension = ImageExtension.PNG, string outputFolderName = null)

Extrai todas as imagens de um PDF e as salva no formato escolhido. Uma sobrecarga aceitando um IResource também está disponível.

IEnumerable<ILocalResource> ExtractAttachmentsFromPdf(string fileName, string password = null, string[] filter = null, string outputFolderName = null)

Extrai os arquivos incorporados em um PDF. Defina filter para limitar a extensões específicas (por exemplo, new[] { ".docx", ".xlsx" }). Uma sobrecarga aceitando um IResource também está disponível.

Gerenciamento de senhas

ILocalResource ManagePdfPassword(string fileName, string oldUserPassword, string newUserPassword, string oldOwnerPassword, string newOwnerPassword, string outputFileName = null)

Define ou remove as senhas do usuário e proprietário em um PDF. Passe null ou uma string vazia como uma nova senha para removê-la. Uma sobrecarga aceitando um IResource também está disponível.

Opções

ConvertToPdfOptions

Opções de layout e conteúdo compartilhados para os métodos de conversão.

• HeaderHtml String - Fragmento de HTML usado como cabeçalho da página. O padrão é null (sem cabeçalho).
• FooterHtml String - Fragmento de HTML usado como rodapé da página. O padrão é null (sem rodapé).
• PaperSize PaperSize - Tamanho do papel para o PDF de saída. O padrão é A4.
• Margin Int - Margem da página em pontos. O padrão é 0.
• Scale Double - Escala de renderização de página, entre 0.1 e 2, inclusive. O padrão é 1.0.

Referência enumerada

ImageExtension

Usado por ExtractImagesFromPdf.

• PNG – Formato de imagem PNG.
• JPEG - Formato de imagem JPEG.
• TIFF – Formato de imagem TIFF.
• BMP – Formato de imagem BMP.

ImageDpi

Usado por ReadPdfWithOcr e ExportPdfPageAsImage.

• Low - 96 DPI.
• Medium - 150 DPI. Padrão.
• High - 270 DPI.

TextAlignment

Usado por ConvertTextToPdf.

• Justify - Alinhamento justificado. Padrão.
• Left - Alinhamento à esquerda.
• Right - Alinhamento à direita.
• Center - Alinhamento central.

PaperSize

Usado por ConvertToPdfOptions.

• A4 (padrão), A3, A5, A2, A6 — Tamanhos ISO A-series.
• Letter, Legal, Tabloid, Ledger, Executive, Statement - Tamanhos americano.
• B4, B5 - Tamanhos ISO série B.
• Number10Envelope, DLEnvelope, C5Envelope, C4Envelope — Tamanhos de envelopes.

Relacionamento com as atividades

A API codificada e as atividades PDF XAML são executadas no mesmo runtime, portanto, um fluxo de trabalho codificado atinge o mesmo comportamento de leitura, conversão e manipulação que as atividades no pacote de atividades PDF. A diferença está no formato da chamada: o serviço pega caminhos de arquivos simples ou IResource entradas e retorna string, int ou ILocalResource resultados diretamente, e você usa try/catch comum em vez da atividade Continuar com erro

Padrões comuns

Ler o texto de um PDF

Esse padrão lê o texto de um intervalo de páginas de um arquivo PDF. ReadPdfText retorna o texto extraído como string um.

[Workflow]
public void Execute()
{
    string text = pdf.ReadPdfText(@"C:\docs\report.pdf", range: "1-3");
    Log(text);
}

Mesclar PDFs e extrair um intervalo de páginas

Esse padrão mescla dois arquivos PDF em um e, em seguida, extrai um intervalo de páginas do resultado mesclado. Cada etapa retorna um ILocalResource apontando para o arquivo de saída.

[Workflow]
public void Execute()
{
    var merged = pdf.JoinPdf(new[] { @"C:\docs\a.pdf", @"C:\docs\b.pdf" }, @"C:\docs\merged.pdf");
    var firstTwoPages = pdf.ExtractPdfPageRange(merged.LocalPath, "1-2", outputFileName: @"C:\docs\excerpt.pdf");
}

Converter HTML em um PDF padrão com margem

Esse padrão converte uma string HTML em um PDF, usando ConvertToPdfOptions para definir um tamanho de papel Carta e uma margem de página. ConvertHtmlToPdf retorna um ILocalResource apontando para o PDF criado.

[Workflow]
public void Execute()
{
    var options = new ConvertToPdfOptions { PaperSize = PaperSize.Letter, Margin = 20 };
    var pdfFile = pdf.ConvertHtmlToPdf("<h1>Report</h1><p>Generated by a coded workflow.</p>", @"C:\docs\report.pdf", options: options);
}