Class Document
Contenu
[
Cacher
]Classe Document
Classe représentant un document PDF.
public sealed class Document : IDisposable
Constructeurs
| Nom | Description |
|---|---|
| Document() | Initialise un document vide. |
| Document(PdfVersion) | Initialise un document vide par version. |
| Document(Stream) | Initialise une nouvelle instance de Document à partir du flux d’entrée. |
| Document(string) | Initialise simplement Document en utilisant nom de fichier. Identique à Document. |
| Document(Stream, bool) | Initialise une nouvelle instance de Document à partir du flux d’entrée. |
| Document(Stream, LoadOptions) | Ouvre un document existant à partir d’un flux en fournissant la conversion nécessaire pour obtenir un document PDF. |
| Document(Stream, string) | Initialise une nouvelle instance de Document à partir du flux d’entrée. |
| Document(string, bool) | Initialise simplement Document en utilisant nom de fichier. Identique à Document. |
| Document(string, LoadOptions) | Ouvre un document existant à partir d’un fichier en fournissant les options de conversion nécessaires pour obtenir un document PDF. |
| Document(string, string) | Initialise une nouvelle instance de la classe Document pour travailler avec un document crypté. |
| Document(Stream, string, bool) | Initialise une nouvelle instance de Document à partir du flux d’entrée. |
| Document(string, string, bool) | Initialise une nouvelle instance de la classe Document pour travailler avec un document crypté. |
Propriétés
| Nom | Description |
|---|---|
| Actions { get; } | Obtient les actions du document. Cette propriété est une instance de la classe DocumentActions qui permet d’obtenir/définir les actions BeforClosing, BeforSaving, etc. |
| AllowReusePageContent { get; set; } | Permet de fusionner le contenu des pages pour optimiser la taille du document. Si utilisé, alors des pages différentes mais dupliquées peuvent référencer le même objet de contenu. Veuillez noter que ce mode peut provoquer des effets secondaires comme le changement du contenu de la page lorsque l’autre page est modifiée. |
| Background { get; set; } | Obtient ou définit la couleur de fond du document. |
| CenterWindow { get; set; } | Obtient ou définit un indicateur spécifiant si la position de la fenêtre du document sera centrée sur l’écran. |
| Collection { get; set; } | Obtient la collection de documents. |
| CryptoAlgorithm { get; } | Obtient les paramètres de sécurité si le document est crypté. Si le document n’est pas crypté, une exception correspondante sera levée dans .net 1.1 ou CryptoAlgorithm sera nul pour d’autres versions .net. |
| Destinations { get; } | Obtient la collection de destinations. Obsolète. Veuillez utiliser NamedDestinations. |
| Direction { get; set; } | Obtient ou définit l’ordre de lecture du texte : L2R (de gauche à droite) ou R2L (de droite à gauche). |
| DisableFontLicenseVerifications { get; set; } | De nombreuses opérations avec des polices ne peuvent pas être exécutées si ces opérations sont interdites par la licence de cette police. Par exemple, certaines polices ne peuvent pas être intégrées dans un document PDF si les règles de licence désactivent l’intégration pour cette police. Ce drapeau est utilisé pour désactiver toutes les restrictions de licence pour toutes les polices dans le document PDF actuel. Soyez prudent lors de l’utilisation de ce drapeau. Lorsqu’il est défini, cela signifie que la personne qui définit ce drapeau assume toute la responsabilité des violations possibles de licence/droit. Il le prend donc à ses propres risques. Il est fortement recommandé d’utiliser ce drapeau uniquement lorsque vous êtes pleinement convaincu que vous ne violez pas la loi sur le droit d’auteur. Par défaut, faux. |
| DisplayDocTitle { get; set; } | Obtient ou définit un indicateur spécifiant si la barre de titre de la fenêtre du document doit afficher le titre du document. |
| Duplex { get; set; } | Obtient ou définit l’option de gestion du mode d’impression recto verso à utiliser lors de l’impression du fichier à partir de la boîte de dialogue d’impression. |
| EmbeddedFiles { get; } | Obtient la collection de fichiers intégrés au document. |
| EmbedStandardFonts { get; set; } | Propriété qui déclare que le document doit intégrer toutes les polices standard de type 1 qui ont le drapeau IsEmbedded défini sur vrai. Toutes les polices PDF peuvent être intégrées dans le document simplement en définissant le drapeau IsEmbedded sur vrai, mais les polices standard de type 1 PDF sont une exception à cette règle. L’intégration des polices standard de type 1 nécessite beaucoup de temps, donc pour intégrer ces polices, il est nécessaire non seulement de définir le drapeau IsEmbedded sur vrai pour la police spécifiée, mais également de définir un drapeau supplémentaire au niveau du document - EmbedStandardFonts = true ; Cette propriété ne peut être définie qu’une seule fois pour toutes les polices. Par défaut, faux. |
| EnableObjectUnload { get; set; } | Obtient ou définit un indicateur qui permet de décharger partiellement le document de la mémoire. Cela permet de réduire l’utilisation de la mémoire mais peut avoir un effet négatif sur les performances. |
| EnableSignatureSanitization { get; set; } | Obtient ou définit un indicateur pour gérer la désinfection des champs de signature. Activé par défaut. |
| FileName { get; } | Nom du fichier PDF qui a causé ce document |
| FitWindow { get; set; } | Obtient ou définit un indicateur spécifiant si la fenêtre du document doit être redimensionnée pour s’adapter à la première page affichée. |
| FontUtilities { get; } | Instance IDocumentFontUtilities |
| Form { get; } | Obtient le formulaire Acro du document. |
| HandleSignatureChange { get; set; } | Lève une exception si le document sera enregistré avec des modifications et a une signature |
| HideMenubar { get; set; } | Obtient ou définit un indicateur spécifiant si la barre de menu doit être masquée lorsque le document est actif. |
| HideToolBar { get; set; } | Obtient ou définit un indicateur spécifiant si la barre d’outils doit être masquée lorsque le document est actif. |
| HideWindowUI { get; set; } | Obtient ou définit un indicateur spécifiant si les éléments de l’interface utilisateur doivent être masqués lorsque le document est actif. |
| Id { get; } | Obtient l’ID. |
| IgnoreCorruptedObjects { get; set; } | Obtient ou définit un indicateur d’ignorance des erreurs dans les fichiers sources. Lorsque des pages du document source sont copiées dans le document de destination, le processus de copie est arrêté avec une exception si certains objets dans les fichiers sources sont corrompus lorsque ce drapeau est faux. exemple : dest.Pages.Add(src.Pages); Si ce drapeau est défini sur vrai, alors les objets corrompus seront remplacés par des valeurs vides. Par défaut : vrai. |
| Info { get; } | Obtient les informations du document. |
| IsEncrypted { get; } | Obtient le statut crypté du document. Vrai si le document est crypté. |
| IsLinearized { get; set; } | Obtient ou définit une valeur indiquant si le document est linéarisé. |
| IsPdfaCompliant { get; } | Obtient si le document est conforme au pdfa. |
| IsPdfUaCompliant { get; } | Obtient si le document est conforme au pdfua. |
| IsXrefGapsAllowed { get; set; } | Obtient ou définit si le document est conforme au pdfa. |
| JavaScript { get; } | Collection de JavaScript au niveau du document. |
| LogicalStructure { get; } | Obtient la structure logique du document. |
| Metadata { get; } | Métadonnées du document. (Un document PDF peut inclure des informations générales, telles que le titre du document, l’auteur et les dates de création et de modification. Ces informations globales sur le document (par opposition à son contenu ou à sa structure) sont appelées métadonnées et sont destinées à aider à cataloguer et à rechercher des documents dans des bases de données externes.) |
| NamedDestinations { get; } | Collection de destinations nommées dans le document. |
| NonFullScreenPageMode { get; set; } | Obtient ou définit le mode de page, spécifiant comment afficher le document en quittant le mode plein écran. |
| OpenAction { get; set; } | Obtient ou définit l’action effectuée à l’ouverture du document. |
| OptimizeSize { get; set; } | Obtient ou définit le drapeau d’optimisation. Lorsque des pages sont ajoutées au document, des flux de ressources égaux dans le fichier résultant sont fusionnés en un seul objet PDF si ce drapeau est défini. Cela permet de réduire la taille du fichier résultant mais peut entraîner une exécution plus lente et des exigences de mémoire plus importantes. Valeur par défaut : faux. |
| Outlines { get; } | Obtient les contours du document. |
| OutputIntents { get; } | Obtient la collection d’intentions de sortie dans le document. |
| PageInfo { get; set; } | Obtient ou définit les informations de page. (pour le générateur uniquement, non rempli lors de la lecture du document) |
| PageLabels { get; } | Obtient les étiquettes de page dans le document. |
| PageLayout { get; set; } | Obtient ou définit la mise en page de la page qui doit être utilisée lorsque le document est ouvert. |
| PageMode { get; set; } | Obtient ou définit le mode de page, spécifiant comment le document doit être affiché lorsqu’il est ouvert. |
| Pages { get; } | Obtient ou définit la collection de pages du document. Notez que les pages sont numérotées à partir de 1 dans la collection. |
| PdfFormat { get; } | Obtient le format PDF |
| Permissions { get; } | Obtient les autorisations du document. |
| PickTrayByPdfSize { get; set; } | Obtient ou définit un indicateur spécifiant si la taille de la page PDF doit être utilisée pour sélectionner le bac à papier d’entrée. |
| PrintScaling { get; set; } | Obtient ou définit l’option de mise à l’échelle de la page qui doit être sélectionnée lorsque la boîte de dialogue d’impression est affichée pour ce document. |
| TaggedContent { get; } | Obtient l’accès au contenu TaggedPdf. |
| Version { get; } | Obtient une version de Pdf à partir de l’en-tête du fichier Pdf. |
| static FileSizeLimitToMemoryLoading { get; set; } | Obtient et définit la limite de taille de fichier pour charger un fichier entier en mémoire. La valeur est définie en mégaoctets. La valeur par défaut est 210 Mo. |
| static IsLicensed { get; } | Obtient l’état de licence du système. Renvoie vrai si le système fonctionne en mode sous licence et faux sinon. |
Méthodes
| Nom | Description |
|---|---|
| static MergeDocuments(params Document[]) | Fusionne des documents. |
| static MergeDocuments(params string[]) | Fusionne des fichiers PDF. |
| static MergeDocuments(MergeOptions, params Document[]) | Fusionne des documents. |
| static MergeDocuments(MergeOptions, params string[]) | Fusionne des documents. |
| BindXml(Stream) | Lier xml au document |
| BindXml(string) | Lier xml au document |
| BindXml(Stream, Stream) | Lier xml/xsl au document |
| BindXml(string, string) | Lier xml/xsl au document |
| BindXml(Stream, Stream, XmlReaderSettings) | Lier xml/xsl au document |
| ChangePasswords(string, string, string) | Change les mots de passe du document. Cette action ne peut être effectuée qu’en utilisant le mot de passe propriétaire. |
| Check(bool) | Valide le document. |
| Convert(PdfFormatConversionOptions) | Convertit le document en utilisant les options de conversion spécifiées |
| Convert(CallBackGetHocr, bool) | Reconnaît les images à l’intérieur du document et ajoute des chaînes hocr par-dessus. |
| Convert(CallBackGetHocrWithPage, bool) | Reconnaît les images à l’intérieur du document et ajoute des chaînes hocr par-dessus. |
| Convert(Stream, PdfFormat, ConvertErrorAction) | Convertit le document et enregistre les erreurs dans le flux spécifié. |
| Convert(string, PdfFormat, ConvertErrorAction) | Convertit le document et enregistre les erreurs dans le fichier spécifié. |
| Convert(Fixup, Stream, bool, object[]) | Convertit le document en appliquant le Fixup. |
| Convert(Fixup, string, bool, object[]) | Convertit le document en appliquant le Fixup. |
| Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction) | Convertit le document et enregistre les erreurs dans le fichier spécifié. |
| Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction) | Convertit le document et enregistre les erreurs dans le fichier spécifié. |
| ConvertPageToPNGMemoryStream(Page) | Convertit la page en PNG pour le flux d’image DSR, OMR, OCR. |
| Decrypt() | Décrypte le document. Appelez ensuite Save pour obtenir la version décryptée du document. |
| Dispose() | Ferme toutes les ressources utilisées par ce document. |
| Encrypt(string, string, Permissions, CryptoAlgorithm) | Crypte le document. Appelez ensuite Save pour obtenir la version cryptée du document. |
| Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool) | Crypte le document. Appelez ensuite Save pour obtenir la version cryptée du document. |
| Encrypt(string, string, Permissions, CryptoAlgorithm, bool) | Crypte le document. Appelez ensuite Save pour obtenir la version cryptée du document. |
| ExportAnnotationsToXfdf(Stream) | Exporte toutes les annotations du document dans le flux. |
| ExportAnnotationsToXfdf(string) | Exporte toutes les annotations du document vers un fichier XFDF |
| Flatten() | Supprime tous les champs du document et place leurs valeurs à la place. |
| Flatten(FlattenSettings) | Supprime tous les champs (et annotations) du document et place leurs valeurs à la place. |
| FlattenTransparency() | Remplace le contenu transparent par des graphiques raster et vectoriels non transparents. |
| FreeMemory() | Efface la mémoire |
| GetCatalogValue(string) | Renvoie la valeur de l’élément du dictionnaire de catalogues. |
| GetObjectById(string) | Obtient un objet avec l’ID spécifié dans le document. |
| GetXmpMetadata(Stream) | Obtient les métadonnées XMP du document. |
| HasIncrementalUpdate() | Vérifie si le document PDF actuel a été enregistré avec des mises à jour incrémentielles. |
| ImportAnnotationsFromXfdf(Stream) | Importe des annotations du flux vers le document. |
| ImportAnnotationsFromXfdf(string) | Importe des annotations du fichier XFDF vers le document. |
| IsRepairNeeded(out RepairOptions) | Vérifie si le document nécessite un appel à la méthode Repair. |
| LoadFrom(string, LoadOptions) | Charge un fichier, le convertissant en PDF. |
| Merge(params Document[]) | Fusionne des documents. |
| Merge(params string[]) | Fusionne des fichiers PDF. |
| Merge(MergeOptions, params Document[]) | Fusionne des documents. |
| Merge(MergeOptions, params string[]) | Fusionne des documents. |
| Optimize() | Linéarise le document afin de - ouvrir la première page aussi rapidement que possible ; - afficher la page suivante ou suivre un lien vers la page suivante aussi rapidement que possible ; - afficher la page de manière incrémentielle à mesure qu’elle arrive lorsque les données pour une page sont livrées sur un canal lent (afficher d’abord les données les plus utiles) ; - permettre l’interaction de l’utilisateur, comme suivre un lien, à effectuer même avant que la page entière ait été reçue et affichée. L’invocation de cette méthode ne sauvegarde pas réellement le document. Au contraire, le document est seulement préparé pour avoir une structure optimisée, appelez ensuite Save pour obtenir un document optimisé. |
| OptimizeResources() | Optimise les ressources dans le document : 1. Les ressources qui ne sont pas utilisées sur les pages du document sont supprimées ; 2. Les ressources égales sont regroupées en un seul objet ; 3. Les objets non utilisés sont supprimés. |
| OptimizeResources(OptimizationOptions) | Optimise les ressources dans le document selon la stratégie d’optimisation définie. |
| PageNodesToBalancedTree(byte) | Organise les nœuds d’arbre de page dans un document en un arbre équilibré. Seulement si le document a plus de nodesNumInSubtrees objets de page, sinon il ne fait rien. Ne pas appeler cette méthode lors de l’itération sur les éléments Pages, cela peut donner des résultats imprévisibles |
| ProcessParagraphs() | Traite les paragraphes pour le générateur. |
| RemoveMetadata() | Supprime les métadonnées du document. |
| RemovePdfaCompliance() | Supprime la conformité pdfa du document |
| RemovePdfUaCompliance() | Supprime la conformité pdfUa du document |
| Repair(RepairOptions) | Répare le document corrompu. |
| Save() | Sauvegarde le document de manière incrémentielle (c’est-à-dire en utilisant la technique de mise à jour incrémentielle). |
| Save(SaveOptions) | Sauvegarde le document avec des options de sauvegarde. |
| Save(Stream) | Stocke le document dans un flux. |
| Save(string) | Sauvegarde le document dans le fichier spécifié. |
| Save(Stream, SaveFormat) | Sauvegarde le document avec un nouveau nom ainsi qu’un format de fichier. |
| Save(Stream, SaveOptions) | Sauvegarde le document dans un flux avec des options de sauvegarde. |
| Save(string, SaveFormat) | Sauvegarde le document avec un nouveau nom ainsi qu’un format de fichier. |
| Save(string, SaveOptions) | Sauvegarde le document avec un nouveau nom en définissant ses options de sauvegarde. |
| SaveAsync(CancellationToken) | Sauvegarde le document de manière incrémentielle (c’est-à-dire en utilisant la technique de mise à jour incrémentielle). |
| SaveAsync(SaveOptions, CancellationToken) | Sauvegarde le document avec des options de sauvegarde. |
| SaveAsync(Stream, CancellationToken) | Stocke le document dans un flux. |
| SaveAsync(string, CancellationToken) | Sauvegarde le document dans le fichier spécifié. |
| SaveAsync(Stream, SaveFormat, CancellationToken) | Sauvegarde le document avec un nouveau nom ainsi qu’un format de fichier. |
| SaveAsync(Stream, SaveOptions, CancellationToken) | Sauvegarde le document dans un flux avec des options de sauvegarde. |
| SaveAsync(string, SaveFormat, CancellationToken) | Sauvegarde le document avec un nouveau nom ainsi qu’un format de fichier. |
| SaveAsync(string, SaveOptions, CancellationToken) | Sauvegarde le document avec un nouveau nom en définissant ses options de sauvegarde. |
| SaveXml(string) | Sauvegarde le document au format XML. |
| SendTo(DocumentDevice, Stream) | Envoie l’ensemble du document à l’appareil de document pour traitement. |
| SendTo(DocumentDevice, string) | Envoie l’ensemble du document à l’appareil de document pour traitement. |
| SendTo(DocumentDevice, int, int, Stream) | Envoie certaines pages du document à l’appareil de document pour traitement. |
| SendTo(DocumentDevice, int, int, string) | Envoie l’ensemble du document à l’appareil de document pour traitement. |
| SetTitle(string) | Définit le titre pour le document PDF |
| SetXmpMetadata(Stream) | Définit les métadonnées XMP du document. |
| Validate(PdfFormatConversionOptions) | Valide le document dans le fichier spécifié. |
| Validate(Stream, PdfFormat) | Valide le document dans le fichier spécifié. |
| Validate(string, PdfFormat) | Valide le document dans le fichier spécifié. |
| static Convert(Stream, LoadOptions, Stream, SaveOptions) | Convertit le flux dans le format source en flux dans le format de destination. |
| static Convert(Stream, LoadOptions, string, SaveOptions) | Convertit le flux dans le format source en fichier de destination dans le format de destination. |
| static Convert(string, LoadOptions, Stream, SaveOptions) | Convertit le fichier source dans le format source en flux dans le format de destination. |
| static Convert(string, LoadOptions, string, SaveOptions) | Convertit le fichier source dans le format source en fichier de destination dans le format de destination. |
| static SetDefaultFileSizeLimitToMemoryLoading() | Définit la limite de taille de fichier pour charger un fichier entier en mémoire à la valeur par défaut égale à 210 Mo. |
Champs
| Nom | Description |
|---|---|
| const DefaultNodesNumInSubtrees |
Événements
| Nom | Description |
|---|---|
| event FontSubstitution | Se produit lorsque la police remplace une autre police dans le document. |
Autres membres
| Nom | Description |
|---|---|
| delegate CallBackGetHocr | |
| delegate CallBackGetHocrWithPage | |
| delegate FontSubstitutionHandler | Représente la méthode qui gérera l’événement FontSubstitution. |
| interface IDocumentFontUtilities | Contient des fonctionnalités pour ajuster les polices |
| class MergeOptions | Représente les options pour les méthodes de fusion. |
| class RepairOptions | Représente les options pour réparer un document PDF. |
Voir aussi
- namespace Aspose.Pdf
- assembly Aspose.PDF
