API d'automatisation codée PDF (aperçu)

API d'automatisation codée pour le package d'activités PDF, couvrant la lecture, la fusion, la conversion et la manipulation de fichiers PDF et XPS.

UiPath.PDF.Activities

API de workflow codé pour la lecture, la fusion, la conversion et la manipulation de fichiers PDF et XPS. Ces API sont disponibles lors de la conception d'automatisations codées. Pour obtenir une introduction aux automatisations codées et à leur conception à l'aide d'API, consultez la section Automatisations codées.

• Accéder au service: pdf (type IPdfService)
• Package requis: "UiPath.PDF.Activities": "*" dans les dépendances project.json .

Espaces de noms importés automatiquement

Les espaces de noms suivants sont automatiquement disponibles dans les workflows codés lorsque le package PDF est installé:

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

Vue d’ensemble du service

Le service pdf expose chaque opération sous forme d'appel de méthode direct. Il n’y a aucune connexion ni étendue à ouvrir. La plupart des opérations fournissent deux formulaires: l'un qui prend un chemin de fichier comme string, et l'autre qui prend un IResource (par exemple, la sortie de l'activité Chemin d'accès existe ou Obtenir le fichier/dossier local ). Appelez directement des méthodes sur l’accesseur du service:

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

Les méthodes qui créent ou transforment un fichier renvoient un pointeur ILocalResource à la sortie. Lorsque la valeur outputFileName est null, le service génère automatiquement un nom. Les fichiers protégés par un mot de passe sont ouverts en transmettant le paramètre password. Le range paramètre accepte "All" ou des plages explicites telles que "1-3,5".

Lecture du texte

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

Lit le texte d'un fichier PDF. Définissez preserveFormatting sur true pour conserver la mise en page du texte. Une surcharge acceptant une IResource est également disponible.

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

Lit le texte d’un fichier PDF numérisé à l’aide du moteur OCR fourni. Obtenez un moteur OCR auprès du service OCR (par exemple, IOcrService.GetUiPathDocumentOcr). degreeOfParallelism définit le nombre de pages à traiter à la fois. Windows uniquement.

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

Lit le texte d'un fichier XPS. Une surcharge acceptant une IResource est également disponible. Windows uniquement.

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

Lit le texte d’un fichier XPS à l’aide du moteur OCR fourni. Windows uniquement.

Opérations de page et de document

int GetPdfPageCount(string fileName, string password = null)

Renvoie le nombre de pages dans un fichier PDF. Une surcharge acceptant une IResource est également disponible.

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

Fusionne plusieurs fichiers PDF en un seul PDF, dans l’ordre indiqué. Une surcharge acceptant une IResource[] est également disponible.

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

Extrait une plage de pages (par exemple, "1-3,5") d'un fichier PDF dans un nouveau PDF. Une surcharge acceptant une IResource est également disponible.

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

Exporte une seule page (pageNumber basé sur 1) en tant qu'image. Le format d'image est déduit de l'extension outputFileName. Une surcharge acceptant une IResource est également disponible.

Création et conversion

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

Crée un PDF à partir d’une liste de fichiers image, une image par page. Formats d’entrée pris en charge: PNG, JPG, JPEG, TIF, TIFF, BMP. Une surcharge acceptant une IResource[] est également disponible.

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

Convertit du contenu HTML en PDF. Définissez keepBackground sur true pour conserver les couleurs et les graphiques d’arrière-plan.

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

Convertit un message électronique en PDF.

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

Convertit du texte brut en PDF, avec une taille de police et un alignement du texte configurables.

Extraction des images et des pièces jointes

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

Extrait toutes les images d’un PDF et les enregistre dans le format choisi. Une surcharge acceptant une IResource est également disponible.

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

Extrait les fichiers intégrés dans un PDF. Définissez filter pour vous limiter à des extensions spécifiques (par exemple, new[] { ".docx", ".xlsx" }). Une surcharge acceptant une IResource est également disponible.

Gestion des mots de passe

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

Définit ou supprime les mots de passe utilisateur et propriétaire d’un fichier PDF. Saisissez null ou une chaîne vide comme nouveau mot de passe pour le supprimer. Une surcharge acceptant une IResource est également disponible.

Options

ConvertToPdfOptions

Options de mise en page et de contenu partagées pour les méthodes de conversion.

• HeaderHtml String - Extrait HTML utilisé comme en-tête de la page. La valeur par défaut est null (aucun en-tête).
• FooterHtml String - Extrait HTML utilisé comme pied de page. La valeur par défaut est null (pas de pied de page).
• PaperSize PaperSize - Format de papier pour le PDF de sortie. La valeur par défaut est A4.
• Margin Int - Marge de la page en points. La valeur par défaut est 0.
• Scale Double - Échelle du rendu de la page, comprise entre 0.1 et 2 inclus. La valeur par défaut est 1.0.

Enum référence

ImageExtension

Utilisé par ExtractImagesFromPdf.

• PNG - Format d'image PNG.
• JPEG - Format d'image JPEG.
• TIFF - format d'image TIFF.
• BMP - Format d'image BMP.

ImageDpi

Utilisé par ReadPdfWithOcr et ExportPdfPageAsImage.

• Low - 96 PPP.
• Medium - 150 PPP. Par défaut.
• High - 270 PPP.

TextAlignment

Utilisé par ConvertTextToPdf.

• Justify - Alignement Justifié. Par défaut.
• Left - Alignement de gauche.
• Right - Alignement de droite.
• Center - Alignement au centre.

PaperSize

Utilisé par ConvertToPdfOptions.

• A4 (par défaut), A3, A5, A2, A6 - tailles ISO de la série A.
• Letter, Legal, Tabloid, Ledger, Executive, Statement - tailles pour l'Amérique du Nord.
• B4, B5 - tailles ISO de la série B.
• Number10Envelope, DLEnvelope, C5Envelope, C4Envelope - Tailles de l'enveloppe.

Relation avec les activités

L’API codée et les activités PDF XAML s’exécutent sur le même runtime, de sorte qu’un workflow codé atteint le même comportement de lecture, de conversion et de manipulation que les activités du package d’activités PDF. La différence est au niveau de la forme de l'appel: le service prend des chemins de fichiers simples ou des entrées IResource et renvoie directement les résultats string, int ou ILocalResource , et vous utilisez le mode try/catch au lieu de l'activité Option ContinuerSurErreur .

Modèles communs

Lire le texte d’un PDF

Ce modèle va lire le texte d’une plage de pages à partir d’un fichier PDF. ReadPdfText renvoie le texte extrait sous forme de string.

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

Fusionner des fichiers PDF et extraire une plage de pages

Ce modèle fusionne deux fichiers PDF en un seul, puis extrait une plage de pages du résultat de la fusion. Chaque étape renvoie un ILocalResource pointant vers le fichier de sortie.

[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");
}

Convertir le contenu HTML en PDF de taille lettre avec une marge

Ce modèle convertit une chaîne HTML en PDF, en utilisant ConvertToPdfOptions pour définir le format Lettre et la marge de la page. ConvertHtmlToPdf renvoie un ILocalResource pointant vers le PDF créé.

[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);
}