Class Document
Namespace: Aspose.Pdf
Assembly: Aspose.PDF.dll
Classe représentant un document PDF
public sealed class Document : IDisposable
Héritage
Implémente
Membres hérités
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Constructeurs
Document(Stream)
Initialise une nouvelle instance de Document à partir du flux input
.
public Document(Stream input)
Paramètres
input
Stream
Flux contenant le document PDF.
Document(Stream, string, bool)
Initialise une nouvelle instance de Document à partir du flux input
.
public Document(Stream input, string password, bool isManagedStream)
Paramètres
input
Stream
Flux contenant le document PDF.
password
string
Mot de passe utilisateur ou propriétaire.
isManagedStream
bool
Si défini sur true
, le flux interne est fermé avant la sortie ; sinon, il ne l’est pas.
Document(Stream, bool)
Initialise une nouvelle instance de Document à partir du flux input
.
public Document(Stream input, bool isManagedStream)
Paramètres
input
Stream
Flux contenant le document PDF.
isManagedStream
bool
Si défini sur true
, le flux interne est fermé avant la sortie ; sinon, il ne l’est pas.
Document(string)
Initialise simplement le Document en utilisant filename
. Identique à Aspose.Pdf.Document.#ctor(System.IO.Stream).
public Document(string filename)
Paramètres
filename
string
Le nom du fichier du document PDF.
Document(Stream, string)
Initialise une nouvelle instance de Document à partir du flux input
.
public Document(Stream input, string password)
Paramètres
input
Stream
Objet de flux d’entrée, le PDF est protégé par mot de passe.
password
string
Mot de passe utilisateur ou propriétaire.
Document()
Initialise un document vide.
public Document()
Document(string, string)
Initialise une nouvelle instance de la classe Aspose.Pdf.Document pour travailler avec un document chiffré.
public Document(string filename, string password)
Paramètres
filename
string
Nom du fichier du document.
password
string
Mot de passe utilisateur ou propriétaire.
Document(string, string, bool)
Initialise une nouvelle instance de la classe Aspose.Pdf.Document pour travailler avec un document chiffré.
public Document(string filename, string password, bool isManagedStream)
Paramètres
filename
string
Nom du fichier du document.
password
string
Mot de passe utilisateur ou propriétaire.
isManagedStream
bool
Si défini sur true
, le flux interne est fermé avant la sortie ; sinon, il ne l’est pas.
Document(string, LoadOptions)
Ouvre un document existant à partir d’un fichier en fournissant les options de conversion nécessaires pour obtenir un document PDF.
public Document(string filename, LoadOptions options)
Paramètres
filename
string
Fichier d’entrée à convertir en document PDF.
options
LoadOptions
Représente les propriétés pour convertir filename
en document PDF.
Document(Stream, LoadOptions)
Ouvre un document existant à partir d’un flux en fournissant les options de conversion nécessaires pour obtenir un document PDF.
public Document(Stream input, LoadOptions options)
Paramètres
input
Stream
Flux d’entrée à convertir en document PDF.
options
LoadOptions
Représente les propriétés pour convertir input
en document PDF.
Champs
DefaultNodesNumInSubtrees
public const byte DefaultNodesNumInSubtrees = 10
Valeur du champ
Propriétés
Actions
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.
public DocumentActionCollection Actions { get; }
Valeur de la propriété
DocumentActionCollection
Exemples
Cet exemple démontre comment obtenir l’action après l’ouverture du document :
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
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 causer des effets secondaires comme le changement de contenu de page lorsque l’autre page est modifiée.
public bool AllowReusePageContent { get; set; }
Valeur de la propriété
Background
Obtient ou définit la couleur de fond du document.
public Color Background { get; set; }
Valeur de la propriété
Color
CenterWindow
Obtient ou définit un indicateur spécifiant si la position de la fenêtre du document doit être centrée sur l’écran.
public bool CenterWindow { get; set; }
Valeur de la propriété
Exemples
L’exemple démontre comment obtenir l’indicateur CenterWindow :
Document document = new Document("sample.pdf");
bool value = document.CenterWindow;
Collection
Obtient la collection du document.
public Collection Collection { get; set; }
Valeur de la propriété
Collection
CryptoAlgorithm
Obtient les paramètres de sécurité si le document est chiffré. Si le document n’est pas chiffré, alors l’exception correspondante sera levée dans .net 1.1 ou CryptoAlgorithm sera nul pour les autres versions .net.
public CryptoAlgorithm? CryptoAlgorithm { get; }
Valeur de la propriété
CryptoAlgorithm?
Destinations
Obtient la collection des destinations. Obsolète. Veuillez utiliser NamedDestinations.
public DestinationCollection Destinations { get; }
Valeur de la propriété
DestinationCollection
Direction
Obtient ou définit l’ordre de lecture du texte : L2R (de gauche à droite) ou R2L (de droite à gauche).
public Direction Direction { get; set; }
Valeur de la propriété
Direction
DisableFontLicenseVerifications
De nombreuses opérations avec la police 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 le 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 prend l’entière responsabilité des violations possibles de licence/droit. Il prend donc ce risque sur lui-même. 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.
public bool DisableFontLicenseVerifications { get; set; }
Valeur de la propriété
DisplayDocTitle
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.
public bool DisplayDocTitle { get; set; }
Valeur de la propriété
Exemples
L’exemple démontre comment obtenir l’indicateur DisplayDocTitle :
Document document = new Document("sample.pdf");
bool value = document.DisplayDocTitle;
Duplex
Obtient ou définit l’option de gestion du mode duplex d’impression à utiliser lors de l’impression du fichier depuis la boîte de dialogue d’impression.
public PrintDuplex Duplex { get; set; }
Valeur de la propriété
PrintDuplex
EmbedStandardFonts
Propriété qui déclare que le document doit intégrer toutes les polices standard Type1 qui ont le drapeau IsEmbedded défini sur true. Toutes les polices PDF peuvent être intégrées dans le document simplement en définissant le drapeau IsEmbedded sur true, mais les polices standard Type1 sont une exception à cette règle. L’intégration des polices standard Type1 nécessite beaucoup de temps, donc pour intégrer ces polices, il est nécessaire non seulement de définir le drapeau IsEmbedded sur true pour la police spécifiée, mais aussi 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.
public bool EmbedStandardFonts { get; set; }
Valeur de la propriété
EmbeddedFiles
Obtient la collection de fichiers intégrés au document.
public EmbeddedFileCollection EmbeddedFiles { get; }
Valeur de la propriété
EmbeddedFileCollection
EnableObjectUnload
Obtient ou définit un indicateur qui permet au document d’être partiellement déchargé 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.
public bool EnableObjectUnload { get; set; }
Valeur de la propriété
EnableSignatureSanitization
Obtient ou définit un indicateur pour gérer la désinfection des champs de signature. Activé par défaut.
public bool EnableSignatureSanitization { get; set; }
Valeur de la propriété
FileName
Nom du fichier PDF qui a causé ce document
public string FileName { get; }
Valeur de la propriété
FitWindow
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.
public bool FitWindow { get; set; }
Valeur de la propriété
Exemples
L’exemple démontre comment obtenir l’indicateur FitWindow :
Document document = new Document("sample.pdf");
bool value = document.FitWindow;
FontUtilities
Instance IDocumentFontUtilities
public Document.IDocumentFontUtilities FontUtilities { get; }
Valeur de la propriété
Document.IDocumentFontUtilities
Form
Obtient le formulaire Acro du document.
public Form Form { get; }
Valeur de la propriété
Form
HandleSignatureChange
Lève une exception si le document sera enregistré avec des modifications et a une signature.
public bool HandleSignatureChange { get; set; }
Valeur de la propriété
HideMenubar
Obtient ou définit un indicateur spécifiant si la barre de menu doit être cachée lorsque le document est actif.
public bool HideMenubar { get; set; }
Valeur de la propriété
Exemples
L’exemple démontre comment obtenir l’indicateur HideMenubar :
Document document = new Document("sample.pdf");
bool value = document.HideMenubar;
HideToolBar
Obtient ou définit un indicateur spécifiant si la barre d’outils doit être cachée lorsque le document est actif.
public bool HideToolBar { get; set; }
Valeur de la propriété
Exemples
L’exemple démontre comment obtenir l’indicateur HideToolBar :
Document document = new Document("sample.pdf");
bool value = document.HideToolBar;
HideWindowUI
Obtient ou définit un indicateur spécifiant si les éléments de l’interface utilisateur doivent être cachés lorsque le document est actif.
public bool HideWindowUI { get; set; }
Valeur de la propriété
Exemples
L’exemple démontre comment obtenir l’indicateur HideWindowUI :
Document document = new Document("sample.pdf");
bool value = document.HideWindowUI;
Id
Obtient l’ID.
public Id Id { get; }
Valeur de la propriété
Id
IgnoreCorruptedObjects
Obtient ou définit un indicateur d’ignorance des erreurs dans les fichiers sources. Lorsque les 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, les objets corrompus seront remplacés par des valeurs vides. Par défaut : vrai.
public bool IgnoreCorruptedObjects { get; set; }
Valeur de la propriété
Info
Obtient les informations du document.
public DocumentInfo Info { get; }
Valeur de la propriété
DocumentInfo
IsEncrypted
Obtient l’état chiffré du document. Vrai si le document est chiffré.
public bool IsEncrypted { get; }
Valeur de la propriété
IsLicensed
Obtient l’état de licence du système. Renvoie vrai si le système fonctionne en mode licencié et faux sinon.
public static bool IsLicensed { get; }
Valeur de la propriété
IsLinearized
Obtient ou définit une valeur indiquant si le document est linéarisé.
public bool IsLinearized { get; set; }
Valeur de la propriété
IsPdfUaCompliant
Obtient si le document est conforme au pdfua.
public bool IsPdfUaCompliant { get; }
Valeur de la propriété
IsPdfaCompliant
Obtient si le document est conforme au pdfa.
public bool IsPdfaCompliant { get; }
Valeur de la propriété
IsXrefGapsAllowed
Obtient ou définit si le document permet des lacunes dans les xref.
public bool IsXrefGapsAllowed { get; set; }
Valeur de la propriété
JavaScript
Collection de JavaScript au niveau du document.
public JavaScriptCollection JavaScript { get; }
Valeur de la propriété
JavaScriptCollection
LogicalStructure
Obtient la structure logique du document.
public RootElement LogicalStructure { get; }
Valeur de la propriété
RootElement
Metadata
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.)
public Metadata Metadata { get; }
Valeur de la propriété
Metadata
NamedDestinations
Collection de destinations nommées dans le document.
public NamedDestinationCollection NamedDestinations { get; }
Valeur de la propriété
NamedDestinationCollection
NonFullScreenPageMode
Obtient ou définit le mode de page, spécifiant comment afficher le document en quittant le mode plein écran.
public PageMode NonFullScreenPageMode { get; set; }
Valeur de la propriété
PageMode
OpenAction
Obtient ou définit l’action effectuée à l’ouverture du document.
public IAppointment OpenAction { get; set; }
Valeur de la propriété
IAppointment
Exemples
L’exemple démontre comment obtenir l’indicateur CenterWindow :
Document document = new Document("sample.pdf");
IAppointment value = document.OpenAction;
OptimizeSize
Obtient ou définit l’indicateur 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 besoins en mémoire plus importants. Valeur par défaut : faux.
public bool OptimizeSize { get; set; }
Valeur de la propriété
Outlines
Obtient les contours du document.
public OutlineCollection Outlines { get; }
Valeur de la propriété
OutlineCollection
OutputIntents
Obtient la collection des intentions de sortie dans le document.
public OutputIntents OutputIntents { get; }
Valeur de la propriété
OutputIntents
PageInfo
Obtient ou définit les informations de page. (pour le générateur uniquement, non rempli lors de la lecture du document)
public PageInfo PageInfo { get; set; }
Valeur de la propriété
PageInfo
PageLabels
Obtient les étiquettes de page dans le document.
public PageLabelCollection PageLabels { get; }
Valeur de la propriété
PageLabelCollection
PageLayout
Obtient ou définit la mise en page de la page qui doit être utilisée lorsque le document est ouvert.
public PageLayout PageLayout { get; set; }
Valeur de la propriété
PageLayout
PageMode
Obtient ou définit le mode de page, spécifiant comment le document doit être affiché lors de son ouverture.
public PageMode PageMode { get; set; }
Valeur de la propriété
PageMode
Pages
Obtient ou définit la collection de pages du document. Notez que les pages sont numérotées à partir de 1 dans la collection.
public PageCollection Pages { get; }
Valeur de la propriété
PageCollection
Exemples
L’exemple ci-dessous démontre comment travailler avec les pages du document : Comment obtenir le nombre de pages et comment obtenir le rectangle de la première page du document.
Aspose.Pdf.Document document = new Aspose.Pdf.Document("sample.pdf");
Aspose.Pdf.PageCollection pages = document.Pages;
System.Console.WriteLine("Le document contient " + pages.Count);
Page page = pages[1];
Rectangle rect = page.Rect;
PdfFormat
Obtient le format PDF
public PdfFormat PdfFormat { get; }
Valeur de la propriété
PdfFormat
Permissions
Obtient les permissions du document.
public int Permissions { get; }
Valeur de la propriété
PickTrayByPdfSize
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.
public bool PickTrayByPdfSize { get; set; }
Valeur de la propriété
PrintScaling
Obtient ou définit l’option de mise à l’échelle de page qui doit être sélectionnée lorsque la boîte de dialogue d’impression est affichée pour ce document.
public PrintScaling PrintScaling { get; set; }
Valeur de la propriété
PrintScaling
TaggedContent
Obtient l'accès au contenu TaggedPdf.
public ITaggedContent TaggedContent { get; }
Valeur de la propriété
ITaggedContent
Exemples
L'exemple démontre comment utiliser le contenu tagué pour créer un nouveau document avec un en-tête, des paragraphes et des images.
// Créer un nouveau document
Document document = new Document();
// Obtenir le contenu tagué
ITaggedContent taggedContent = document.TaggedContent;
// Définir la langue pour le document
taggedContent.SetLanguage("fr-FR");
// Définir le titre pour le document PDF
taggedContent.SetTitle("Document exemple");
// Création et ajout de Section
SectElement sect = taggedContent.CreateSectElement();
taggedContent.RootElement.AppendChild(sect);
// Créer l'en-tête
HeaderElement h1 = taggedContent.CreateHeaderElement(1);
h1.SetText("L'en-tête");
sect.AppendChild(h1);
// Créer un paragraphe
ParagraphElement p = taggedContent.CreateParagraphElement();
p.SetTag("Paragraph");
p.SetText("Le texte du paragraphe.");
sect.AppendChild(p);
// Créer une illustration
IllustrationElement figure1 = taggedContent.CreateFigureElement();
sect.AppendChild(figure1);
figure1.AlternativeText = "Figure 1";
figure1.Title = "Image 1";
figure1.SetTag("Fig");
figure1.SetImage("path/of/image.jpg");
// Enregistrer le document
document.Save("example.pdf");
Version
Obtient une version de Pdf à partir de l’en-tête du fichier Pdf.
public string Version { get; }
Valeur de la propriété
Méthodes
BindXml(string)
Lie le xml au document
public void BindXml(string file)
Paramètres
file
string
Le fichier xml
BindXml(string, string)
Lie xml/xsl au document
public void BindXml(string xmlFile, string xslFile)
Paramètres
xmlFile
string
Le fichier xml.
xslFile
string
Le fichier xsl si XSLT est utilisé.
BindXml(Stream, Stream)
Lie xml/xsl au document
public void BindXml(Stream xmlStream, Stream xslStream)
Paramètres
xmlStream
Stream
Le flux xml.
xslStream
Stream
Le flux xsl si XSLT est utilisé.
BindXml(Stream, Stream, XmlReaderSettings)
Lie xml/xsl au document
public void BindXml(Stream xmlStream, Stream xslStream, XmlReaderSettings settings)
Paramètres
xmlStream
Stream
Le flux xml.
xslStream
Stream
Le flux xsl si XSLT est utilisé.
settings
XmlReaderSettings
Les paramètres du lecteur xml.
BindXml(Stream)
Lie xml au document
public void BindXml(Stream stream)
Paramètres
stream
Stream
Le flux xml.
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.
public void ChangePasswords(string ownerPassword, string newUserPassword, string newOwnerPassword)
Paramètres
ownerPassword
string
Mot de passe propriétaire.
newUserPassword
string
Nouveau mot de passe utilisateur.
newOwnerPassword
string
Nouveau mot de passe propriétaire.
Check(bool)
Valide le document.
public bool Check(bool doRepair)
Paramètres
doRepair
bool
Si vrai, les problèmes trouvés seront réparés.
Renvoie
Vrai - si le document a été réparé ; sinon, faux.
Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Convertit le document et enregistre les erreurs dans le fichier spécifié.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
Paramètres
outputLogFileName
string
Chemin vers le fichier où les commentaires seront stockés.
format
PdfFormat
Le format pdf.
action
ConvertErrorAction
Action pour les objets qui ne peuvent pas être convertis.
transparencyAction
ConvertTransparencyAction
Action pour les objets masqués par image.
Renvoie
Le résultat de l’opération.
Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Convertit le document et enregistre les erreurs dans le fichier spécifié.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
Paramètres
outputLogStream
Stream
Flux où les commentaires seront stockés.
format
PdfFormat
Le format pdf.
action
ConvertErrorAction
Action pour les objets qui ne peuvent pas être convertis.
transparencyAction
ConvertTransparencyAction
Action pour les objets masqués par image.
Renvoie
Le résultat de l’opération.
Convert(string, PdfFormat, ConvertErrorAction)
Convertit le document et enregistre les erreurs dans le fichier spécifié.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action)
Paramètres
outputLogFileName
string
Chemin vers le fichier où les commentaires seront stockés.
format
PdfFormat
Le format pdf.
action
ConvertErrorAction
Action pour les objets qui ne peuvent pas être convertis.
Renvoie
Le résultat de l’opération.
Convert(PdfFormatConversionOptions)
Convertit le document en utilisant les options de conversion spécifiées.
public bool Convert(PdfFormatConversionOptions options)
Paramètres
options
PdfFormatConversionOptions
ensemble d’options pour convertir le document PDF.
Renvoie
Le résultat de l’opération.
Convert(CallBackGetHocrWithPage, bool)
Reconnaît les images à l’intérieur du document et ajoute des chaînes hocr dessus.
public bool Convert(Document.CallBackGetHocrWithPage callback, bool flattenImages = false)
Paramètres
callback
Document.CallBackGetHocrWithPage
Action pour les images qui seront traitées par la reconnaissance hocr.
flattenImages
bool
Le texte dans les images PDF peut être peint en utilisant la mécanique de masques, auquel cas les images doivent être aplaties.
Renvoie
Le résultat de l’opération. Si aucune image n’est présente dans le document, renvoie faux.
Convert(CallBackGetHocr, bool)
Reconnaît les images à l’intérieur du document et ajoute des chaînes hocr dessus.
public bool Convert(Document.CallBackGetHocr callback, bool flattenImages = false)
Paramètres
callback
Document.CallBackGetHocr
Action pour les images qui seront traitées par la reconnaissance hocr.
flattenImages
bool
Le texte dans les images PDF peut être peint en utilisant la mécanique de masques, auquel cas les images doivent être aplaties.
Renvoie
Le résultat de l’opération. Si aucune image n’est présente dans le document, renvoie faux.
Convert(Stream, PdfFormat, ConvertErrorAction)
Convertit le document et enregistre les erreurs dans le flux spécifié.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action)
Paramètres
outputLogStream
Stream
Flux où les commentaires seront stockés.
format
PdfFormat
Format PDF.
action
ConvertErrorAction
Action pour les objets qui ne peuvent pas être convertis.
Renvoie
Le résultat de l’opération.
Convert(Fixup, Stream, bool, object[])
Convertit le document en appliquant le Fixup.
public bool Convert(Fixup fixup, Stream outputLog, bool onlyValidation = false, object[] parameters = null)
Paramètres
fixup
Fixup
Le type de Fixup.
outputLog
Stream
Le journal du processus.
onlyValidation
bool
Validation uniquement du document.
parameters
object[]
Propriétés pour Fixup qui ne peuvent pas être définies.
Renvoie
Le résultat de l’opération.
Convert(Fixup, string, bool, object[])
Convertit le document en appliquant le Fixup.
public bool Convert(Fixup fixup, string outputLog, bool onlyValidation = false, object[] parameters = null)
Paramètres
fixup
Fixup
Le type de Fixup.
outputLog
string
Le journal du processus.
onlyValidation
bool
Validation uniquement du document.
parameters
object[]
Propriétés pour Fixup qui ne peuvent pas être définies.
Renvoie
Le résultat de l’opération.
Convert(string, LoadOptions, string, SaveOptions)
Convertit le fichier source dans le format source en fichier de destination dans le format de destination.
public static void Convert(string srcFileName, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)
Paramètres
srcFileName
string
Le nom du fichier source.
loadOptions
LoadOptions
Le format du fichier source.
dstFileName
string
Le nom du fichier de destination.
saveOptions
SaveOptions
Le format du fichier de destination.
Convert(Stream, LoadOptions, string, SaveOptions)
Convertit le flux dans le format source en fichier de destination dans le format de destination.
public static void Convert(Stream srcStream, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)
Paramètres
srcStream
Stream
Le flux source.
loadOptions
LoadOptions
Le format du flux source.
dstFileName
string
Le nom du fichier de destination.
saveOptions
SaveOptions
Le format du fichier de destination.
Convert(string, LoadOptions, Stream, SaveOptions)
Convertit le fichier source dans le format source en flux dans le format de destination.
public static void Convert(string srcFileName, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)
Paramètres
srcFileName
string
Le nom du fichier source.
loadOptions
LoadOptions
Le format du fichier source.
dstStream
Stream
Le flux de destination.
saveOptions
SaveOptions
Le format du flux de destination.
Convert(Stream, LoadOptions, Stream, SaveOptions)
Convertit le flux dans le format source en flux dans le format de destination.
public static void Convert(Stream srcStream, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)
Paramètres
srcStream
Stream
Le flux source.
loadOptions
LoadOptions
Le format du flux source.
dstStream
Stream
Le flux de destination.
saveOptions
SaveOptions
Le format du fichier de destination.
ConvertPageToPNGMemoryStream(Page)
Convertit la page en PNG pour le flux d’image DSR, OMR, OCR.
public MemoryStream ConvertPageToPNGMemoryStream(Page page)
Paramètres
page
Page
Page à convertir.
Renvoie
Flux d’image.
Decrypt()
Déchiffre le document. Appelez ensuite Save pour obtenir la version déchiffrée du document.
public void Decrypt()
Dispose()
Ferme toutes les ressources utilisées par ce document.
public void Dispose()
Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool)
Chiffre le document. Appelez ensuite Save pour obtenir la version chiffrée du document.
public void Encrypt(string userPassword, string ownerPassword, DocumentPrivilege privileges, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)
Paramètres
userPassword
string
Mot de passe utilisateur.
ownerPassword
string
Mot de passe propriétaire.
privileges
DocumentPrivilege
Permissions du document, voir Aspose.Pdf.Document.Permissions pour plus de détails.
cryptoAlgorithm
CryptoAlgorithm
Algorithme cryptographique, voir Aspose.Pdf.Document.CryptoAlgorithm pour plus de détails.
usePdf20
bool
Support pour la révision 6 (Extension 8).
Encrypt(string, string, Permissions, CryptoAlgorithm)
Chiffre le document. Appelez ensuite Save pour obtenir la version chiffrée du document.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm)
Paramètres
userPassword
string
Mot de passe utilisateur.
ownerPassword
string
Mot de passe propriétaire.
permissions
Permissions
Permissions du document, voir Aspose.Pdf.Document.Permissions pour plus de détails.
cryptoAlgorithm
CryptoAlgorithm
Algorithme cryptographique, voir Aspose.Pdf.Document.CryptoAlgorithm pour plus de détails.
Encrypt(string, string, Permissions, CryptoAlgorithm, bool)
Chiffre le document. Appelez ensuite Save pour obtenir la version chiffrée du document.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)
Paramètres
userPassword
string
Mot de passe utilisateur.
ownerPassword
string
Mot de passe propriétaire.
permissions
Permissions
Permissions du document, voir Aspose.Pdf.Document.Permissions pour plus de détails.
cryptoAlgorithm
CryptoAlgorithm
Algorithme cryptographique, voir Aspose.Pdf.Document.CryptoAlgorithm pour plus de détails.
usePdf20
bool
Support pour la révision 6 (Extension 8).
ExportAnnotationsToXfdf(string)
Exporte toutes les annotations du document vers un fichier XFDF.
public void ExportAnnotationsToXfdf(string fileName)
Paramètres
fileName
string
Nom du fichier XFDF
ExportAnnotationsToXfdf(Stream)
Exporte toutes les annotations du document dans un flux.
public void ExportAnnotationsToXfdf(Stream stream)
Paramètres
stream
Stream
Flux où stocker le XFDF.
Flatten()
Supprime tous les champs du document et place leurs valeurs à la place.
public void Flatten()
Flatten(FlattenSettings)
Supprime tous les champs (et annotations) du document et place leurs valeurs à la place.
public void Flatten(Form.FlattenSettings flattenSettings)
Paramètres
flattenSettings
Form.FlattenSettings
Paramètres pour le processus d’aplatissement.
FlattenTransparency()
Remplace le contenu transparent par des graphiques raster et vectoriels non transparents.
public void FlattenTransparency()
FreeMemory()
Efface la mémoire
public void FreeMemory()
GetCatalogValue(string)
Renvoie la valeur de l’élément du dictionnaire de catalogues.
public object GetCatalogValue(string key)
Paramètres
key
string
La clé de l’élément.
Renvoie
Valeur de l’élément - si la clé a été trouvée avec succès ; sinon, null.
GetObjectById(string)
Obtient un objet avec l’ID spécifié dans le document.
public object GetObjectById(string id)
Paramètres
id
string
L’ID de l’objet.
Renvoie
L’objet avec l’ID spécifié. Null si l’ID n’est pas trouvé.
GetXmpMetadata(Stream)
Obtenir les métadonnées XMP du document.
public void GetXmpMetadata(Stream stream)
Paramètres
stream
Stream
Flux où les métadonnées seront stockées.
HasIncrementalUpdate()
Vérifie si le document PDF actuel a été enregistré avec des mises à jour incrémentales.
public bool HasIncrementalUpdate()
Renvoie
true
si le document PDF a des mises à jour incrémentales ; sinon, false
.
ImportAnnotationsFromXfdf(string)
Importe des annotations à partir d’un fichier XFDF dans le document.
public void ImportAnnotationsFromXfdf(string fileName)
Paramètres
fileName
string
Nom du fichier XFDF
ImportAnnotationsFromXfdf(Stream)
Imorte des annotations à partir d’un flux dans le document.
public void ImportAnnotationsFromXfdf(Stream stream)
Paramètres
stream
Stream
Flux contenant les données XFDF.
LoadFrom(string, LoadOptions)
Charge un fichier, le convertissant en PDF.
public void LoadFrom(string filename, LoadOptions options)
Paramètres
filename
string
Le chemin vers le fichier à ouvrir.
options
LoadOptions
Les options de chargement.
Exceptions
PdfException
Si le fichier ne peut pas être chargé.
Si le fichier n’est pas trouvé.
Merge(MergeOptions, params Document[])
Fusionne des documents.
public void Merge(Document.MergeOptions mergeOptions, params Document[] documents)
Paramètres
mergeOptions
Document.MergeOptions
Les options de fusion.
documents
Document[]
Les documents à fusionner.
Merge(MergeOptions, params string[])
Fusionne des documents.
public void Merge(Document.MergeOptions mergeOptions, params string[] files)
Paramètres
mergeOptions
Document.MergeOptions
Les options de fusion.
files
string[]
Les fichiers PDF à fusionner.
Merge(params Document[])
Fusionne des documents.
public void Merge(params Document[] documents)
Paramètres
documents
Document[]
Les documents à fusionner.
Merge(params string[])
Fusionne des fichiers PDF.
public void Merge(params string[] files)
Paramètres
files
string[]
Les fichiers PDF à fusionner.
MergeDocuments(MergeOptions, params string[])
Fusionne des documents.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params string[] files)
Paramètres
mergeOptions
Document.MergeOptions
Les options de fusion.
files
string[]
Les fichiers PDF à fusionner.
Renvoie
Le document fusionné.
MergeDocuments(MergeOptions, params Document[])
Fusionne des documents.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params Document[] files)
Paramètres
mergeOptions
Document.MergeOptions
files
Document[]
Les documents à fusionner.
Renvoie
Le document fusionné.
MergeDocuments(params string[])
Fusionne des fichiers PDF.
public static Document MergeDocuments(params string[] files)
Paramètres
files
string[]
Les fichiers PDF à fusionner.
Renvoie
Le document fusionné.
MergeDocuments(params Document[])
Fusionne des documents.
public static Document MergeDocuments(params Document[] documents)
Paramètres
documents
Document[]
Les documents à fusionner.
Renvoie
Le document fusionné.
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 au fur et à mesure qu’elle arrive lorsque les données d’une page sont livrées sur un canal lent (afficher les données les plus utiles en premier) ;
- permettre une interaction utilisateur, telle que le suivi d’un lien, à être effectuée 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é.
public void Optimize()
OptimizeResources()
Optimise les ressources dans le document :
- Les ressources qui ne sont pas utilisées sur les pages du document sont supprimées ;
- Les ressources égales sont jointes en un seul objet ;
- Les objets inutilisés sont supprimés.
public void OptimizeResources()
OptimizeResources(OptimizationOptions)
Optimise les ressources dans le document selon la stratégie d’optimisation définie.
public void OptimizeResources(OptimizationOptions strategy)
Paramètres
strategy
OptimizationOptions
Stratégie d’optimisation.
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 tout en itérant sur les éléments Pages, cela peut donner des résultats imprévisibles.
public void PageNodesToBalancedTree(byte nodesNumInSubtrees = 10)
Paramètres
nodesNumInSubtrees
byte
Nombre désiré de sous-nœuds. La valeur par défaut est dix.
ProcessParagraphs()
Traite les paragraphes pour le générateur.
public void ProcessParagraphs()
RemoveMetadata()
Supprime les métadonnées du document.
public void RemoveMetadata()
RemovePdfUaCompliance()
Supprime la conformité pdfUa du document.
public void RemovePdfUaCompliance()
RemovePdfaCompliance()
Supprime la conformité pdfa du document.
public void RemovePdfaCompliance()
Repair()
Répare le document corrompu.
public void Repair()
Save(Stream)
Stocke le document dans le flux.
public void Save(Stream output)
Paramètres
output
Stream
Flux où le document doit être stocké.
Save(string)
Sauvegarde le document dans le fichier spécifié.
public void Save(string outputFileName)
Paramètres
outputFileName
string
Chemin vers le fichier où le document sera stocké.
Save()
Sauvegarde le document de manière incrémentielle (c’est-à-dire en utilisant la technique de mise à jour incrémentielle).
public void Save()
Remarques
Pour sauvegarder le document de manière incrémentielle, nous devons ouvrir le fichier du document pour écriture. Par conséquent, le Document doit être initialisé avec un flux accessible en écriture comme dans l’extrait de code suivant : Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // effectuer des modifications et sauvegarder le document de manière incrémentielle doc.Save();
Save(SaveOptions)
Sauvegarde le document avec des options de sauvegarde.
public void Save(SaveOptions options)
Paramètres
options
SaveOptions
Options de sauvegarde.
Save(string, SaveFormat)
Sauvegarde le document avec un nouveau nom accompagné d’un format de fichier.
public void Save(string outputFileName, SaveFormat format)
Paramètres
outputFileName
string
Chemin vers le fichier où le document sera stocké.
format
SaveFormat
Options de format.
Save(Stream, SaveFormat)
Sauvegarde le document avec un nouveau nom accompagné d’un format de fichier.
public void Save(Stream outputStream, SaveFormat format)
Paramètres
outputStream
Stream
Flux où le document sera stocké.
format
SaveFormat
Options de format.
Exceptions
System.ArgumentException lorsque Aspose.Pdf.HtmlSaveOptions est passé à une méthode. Sauvegarder un document dans le flux html n’est pas supporté. Veuillez utiliser la méthode pour sauvegarder dans le fichier.
Save(string, SaveOptions)
Sauvegarde le document avec un nouveau nom en définissant ses options de sauvegarde.
public void Save(string outputFileName, SaveOptions options)
Paramètres
outputFileName
string
Chemin vers le fichier où le document sera stocké.
options
SaveOptions
Options de sauvegarde.
Save(Stream, SaveOptions)
Sauvegarde le document dans un flux avec des options de sauvegarde.
public void Save(Stream outputStream, SaveOptions options)
Paramètres
outputStream
Stream
Flux où le document sera stocké.
options
SaveOptions
Options de sauvegarde.
Exceptions
System.ArgumentException lorsque Aspose.Pdf.HtmlSaveOptions est passé à une méthode. Sauvegarder un document dans le flux html n’est pas supporté. Veuillez utiliser la méthode pour sauvegarder dans le fichier.
SaveAsync(Stream, CancellationToken)
Stocke le document dans le flux.
public Task SaveAsync(Stream output, CancellationToken cancellationToken)
Paramètres
output
Stream
Flux où le document doit être stocké.
cancellationToken
CancellationToken
Jeton d’annulation.
Renvoie
Tâche asynchrone.
SaveAsync(string, CancellationToken)
Sauvegarde le document dans le fichier spécifié.
public Task SaveAsync(string outputFileName, CancellationToken cancellationToken)
Paramètres
outputFileName
string
Chemin vers le fichier où le document sera stocké.
cancellationToken
CancellationToken
Jeton d’annulation.
Renvoie
Tâche asynchrone.
SaveAsync(CancellationToken)
Sauvegarde le document de manière incrémentielle (c’est-à-dire en utilisant la technique de mise à jour incrémentielle).
public Task SaveAsync(CancellationToken cancellationToken)
Paramètres
cancellationToken
CancellationToken
Jeton d’annulation.
Renvoie
Tâche asynchrone.
Remarques
Pour sauvegarder le document de manière incrémentielle, nous devons ouvrir le fichier du document pour écriture. Par conséquent, le Document doit être initialisé avec un flux accessible en écriture comme dans l’extrait de code suivant : Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // effectuer des modifications et sauvegarder le document de manière incrémentielle doc.Save();
SaveAsync(SaveOptions, CancellationToken)
Sauvegarde le document avec des options de sauvegarde.
public Task SaveAsync(SaveOptions options, CancellationToken cancellationToken)
Paramètres
options
SaveOptions
Options de sauvegarde.
cancellationToken
CancellationToken
Jeton d’annulation.
Renvoie
Tâche asynchrone.
SaveAsync(string, SaveFormat, CancellationToken)
Sauvegarde le document avec un nouveau nom accompagné d’un format de fichier.
public Task SaveAsync(string outputFileName, SaveFormat format, CancellationToken cancellationToken)
Paramètres
outputFileName
string
Chemin vers le fichier où le document sera stocké.
format
SaveFormat
Options de format.
cancellationToken
CancellationToken
Jeton d’annulation.
Renvoie
Tâche asynchrone.
SaveAsync(Stream, SaveFormat, CancellationToken)
Sauvegarde le document avec un nouveau nom accompagné d’un format de fichier.
public Task SaveAsync(Stream outputStream, SaveFormat format, CancellationToken cancellationToken)
Paramètres
outputStream
Stream
Flux où le document sera stocké.
format
SaveFormat
Options de format.
cancellationToken
CancellationToken
Jeton d’annulation.
Renvoie
Tâche asynchrone.
Exceptions
System.ArgumentException lorsque Aspose.Pdf.HtmlSaveOptions est passé à une méthode. Sauvegarder un document dans le flux html n’est pas supporté. Veuillez utiliser la méthode pour sauvegarder dans le fichier.
SaveAsync(string, SaveOptions, CancellationToken)
Sauvegarde le document avec un nouveau nom en définissant ses options de sauvegarde.
public Task SaveAsync(string outputFileName, SaveOptions options, CancellationToken cancellationToken)
Paramètres
outputFileName
string
Chemin vers le fichier où le document sera stocké.
options
SaveOptions
Options de sauvegarde.
cancellationToken
CancellationToken
Jeton d’annulation.
Renvoie
Tâche asynchrone.
SaveAsync(Stream, SaveOptions, CancellationToken)
Sauvegarde le document dans un flux avec des options de sauvegarde.
public Task SaveAsync(Stream outputStream, SaveOptions options, CancellationToken cancellationToken)
Paramètres
outputStream
Stream
Flux où le document sera stocké.
options
SaveOptions
Options de sauvegarde.
cancellationToken
CancellationToken
Jeton d’annulation.
Renvoie
Tâche asynchrone.
Exceptions
System.ArgumentException lorsque Aspose.Pdf.HtmlSaveOptions est passé à une méthode. Sauvegarder un document dans le flux html n’est pas supporté. Veuillez utiliser la méthode pour sauvegarder dans le fichier.
SaveXml(string)
Sauvegarde le document au format XML.
public void SaveXml(string file)
Paramètres
file
string
Le fichier xml du modèle de document.
SendTo(DocumentDevice, Stream)
Envoie l’ensemble du document au dispositif de document pour traitement.
public void SendTo(DocumentDevice device, Stream output)
Paramètres
device
DocumentDevice
Dispositif de document utilisé pour traiter le document.
output
Stream
Flux de sortie contenant les résultats du traitement du document avec le dispositif donné.
SendTo(DocumentDevice, int, int, Stream)
Envoie certaines pages du document au dispositif