Comment travailler avec les pièces jointes PDF en TypeScript

Ce guide montre comment travailler avec les pièces jointes de fichiers dans les documents PDF avec Aspose.PDF FOSS pour TypeScript. Document.AddAttachment() intègre un fichier au niveau du document; Page.AddFileAttachment() place une annotation en forme de trombone cliquable sur une page qui ouvre le fichier intégré. Il nécessite Node.js 22 ou ultérieur.

Guide étape par étape

Étape 1: installer le package

git clone https://github.com/aspose-pdf-foss/Aspose.PDF-FOSS-for-TypeScript.git
cd Aspose.PDF-FOSS-for-TypeScript
npm install
npm run build

Vérifiez l’installation en important la classe Document dans un nouveau fichier TypeScript — cette ligne devrait se résoudre sans erreur une fois le package installé:

import { Document } from '@asposefoss/pdf';

Étape 2: importer les classes requises

Importez Document pour ouvrir le fichier et accéder aux deux points d’entrée des pièces jointes utilisés ci-dessous :

import { Document } from '@asposefoss/pdf';

Étape 3 : Ouvrir le document cible

Les deux méthodes d’attachement sont appelées sur un Document ouvert — les attachements de niveau Page nécessitent en outre le Page cible :

const doc = Document.OpenFile('input.pdf');
const page = doc.Pages[0];

Étape 4 : Intégrer une pièce jointe au niveau du document

Document.AddAttachment(name, bytes, opts) -> Attachment intègre un fichier dans la collection de fichiers intégrés du document, indexée par name. Document.GetAttachments() -> Attachment[] répertorie tout ce qui est actuellement intégré, et Document.RemoveAttachment(name) -> boolean en supprime un par son nom.

Étape 5 : Ajouter une annotation de pièce jointe de fichier au niveau de la page

Page.AddFileAttachment(opts) -> FileAttachmentAnnotation place une icône cliquable sur la page — similaire aux annotations de type note autocollante et texte libre présentées dans le Annotations guide — qu’un visualiseur ouvre pour enregistrer ou prévisualiser le fichier incorporé. Contrairement à Document.AddAttachment(), il est ancré à un emplacement de page spécifique plutôt que listé uniquement dans la collection de fichiers incorporés du document.

Problèmes courants et solutions

Une pièce jointe ajoutée avec Document.AddAttachment() n’a aucune icône visible sur aucune page. C’est prévu — une pièce jointe au niveau du document réside dans la collection de fichiers incorporés, pas sur une page. Utilisez Page.AddFileAttachment() en complément si une icône cliquable sur une page spécifique est requise.

Document.RemoveAttachment() returns false. Il renvoie false lorsqu’aucune pièce jointe n’est enregistrée sous le donné name — listez l’ensemble actuel avec Document.GetAttachments() d’abord pour confirmer le nom exact utilisé.

Deux pièces jointes ont été intégrées sous le même name. name in Document.AddAttachment() est la clé utilisée pour retrouver la pièce jointe avec RemoveAttachment() — réutiliser un nom pour un second appel peut masquer ou entrer en conflit avec le premier, selon la manière dont le visualiseur résout les duplicata. Utilisez un nom distinct pour chaque fichier intégré.

Foire aux questions

Quelle est la différence entre une pièce jointe au niveau du document et une pièce jointe au niveau de la page?

Une pièce jointe au niveau du document (Document.AddAttachment()) se trouve dans la collection embedded-files du PDF et n’est liée à aucune page. Une pièce jointe au niveau de la page (Page.AddFileAttachment()) est une annotation ancrée à un emplacement de page spécifique, similaire à une note autocollante.

Comment puis-je voir ce qui est actuellement incorporé dans un document?

Appelez Document.GetAttachments(), qui renvoie tous les Attachment actuellement intégrés.

Une pièce jointe peut-elle être supprimée après avoir été ajoutée?

Oui — Document.RemoveAttachment(name) supprime une pièce jointe au niveau du document par le nom sous lequel elle a été ajoutée, et renvoie true si elle en a trouvé et en a supprimé une.