Class Document
Namespace: Aspose.Pdf
Assembly: Aspose.PDF.dll
Klasse, die ein PDF-Dokument darstellt
public sealed class Document : IDisposable
Vererbung
Implementiert
Vererbte Mitglieder
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Konstruktoren
Document(Stream)
Initialisiert eine neue Document-Instanz aus dem input
-Stream.
public Document(Stream input)
Parameter
input
Stream
Stream mit PDF-Dokument.
Document(Stream, string, bool)
Initialisiert eine neue Document-Instanz aus dem input
-Stream.
public Document(Stream input, string password, bool isManagedStream)
Parameter
input
Stream
Stream mit PDF-Dokument.
password
string
Benutzer- oder Eigentümerpasswort.
isManagedStream
bool
Wenn auf true
gesetzt, wird der innere Stream vor dem Verlassen geschlossen; andernfalls nicht.
Document(Stream, bool)
Initialisiert eine neue Document-Instanz aus dem input
-Stream.
public Document(Stream input, bool isManagedStream)
Parameter
input
Stream
Stream mit PDF-Dokument.
isManagedStream
bool
Wenn auf true
gesetzt, wird der innere Stream vor dem Verlassen geschlossen; andernfalls nicht.
Document(string)
Initialisiert einfach das Document unter Verwendung von filename
. Dasselbe wie Aspose.Pdf.Document.#ctor(System.IO.Stream).
public Document(string filename)
Parameter
filename
string
Der Name der PDF-Dokumentdatei.
Document(Stream, string)
Initialisiert eine neue Document-Instanz aus dem input
-Stream.
public Document(Stream input, string password)
Parameter
input
Stream
Eingabe-Stream-Objekt, das entsprechende PDF ist passwortgeschützt.
password
string
Benutzer- oder Eigentümerpasswort.
Document()
Initialisiert ein leeres Dokument.
public Document()
Document(string, string)
Initialisiert eine neue Instanz der Aspose.Pdf.Document-Klasse zum Arbeiten mit verschlüsselten Dokumenten.
public Document(string filename, string password)
Parameter
filename
string
Dokumentdateiname.
password
string
Benutzer- oder Eigentümerpasswort.
Document(string, string, bool)
Initialisiert eine neue Instanz der Aspose.Pdf.Document-Klasse zum Arbeiten mit verschlüsselten Dokumenten.
public Document(string filename, string password, bool isManagedStream)
Parameter
filename
string
Dokumentdateiname.
password
string
Benutzer- oder Eigentümerpasswort.
isManagedStream
bool
Wenn auf true
gesetzt, wird der innere Stream vor dem Verlassen geschlossen; andernfalls nicht.
Document(string, LoadOptions)
Öffnet ein vorhandenes Dokument aus einer Datei und bietet die erforderlichen Konvertierungsoptionen, um ein PDF-Dokument zu erhalten.
public Document(string filename, LoadOptions options)
Parameter
filename
string
Eingabedatei zur Konvertierung in ein PDF-Dokument.
options
LoadOptions
Stellt Eigenschaften für die Konvertierung von filename
in ein PDF-Dokument dar.
Document(Stream, LoadOptions)
Öffnet ein vorhandenes Dokument aus einem Stream und bietet die erforderlichen Konvertierungsoptionen, um ein PDF-Dokument zu erhalten.
public Document(Stream input, LoadOptions options)
Parameter
input
Stream
Eingabe-Stream zur Konvertierung in ein PDF-Dokument.
options
LoadOptions
Stellt Eigenschaften für die Konvertierung von input
in ein PDF-Dokument dar.
Felder
DefaultNodesNumInSubtrees
public const byte DefaultNodesNumInSubtrees = 10
Feldwert
Eigenschaften
Actions
Erhält die Dokumentaktionen. Diese Eigenschaft ist eine Instanz der DocumentActions-Klasse, die es ermöglicht, Befehle wie BeforClosing, BeforSaving usw. zu erhalten oder festzulegen.
public DocumentActionCollection Actions { get; }
Eigenschaftswert
DocumentActionCollection
Beispiele
Dieses Beispiel zeigt, wie man die Aktion nach dem Öffnen des Dokuments erhält:
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
Erlaubt das Zusammenführen von Seiteninhalten, um die Dokumentgröße zu optimieren. Wenn verwendet, können unterschiedliche, aber duplizierte Seiten auf dasselbe Inhaltsobjekt verweisen. Bitte beachten Sie, dass dieser Modus Nebenwirkungen wie das Ändern des Seiteninhalts verursachen kann, wenn eine andere Seite geändert wird.
public bool AllowReusePageContent { get; set; }
Eigenschaftswert
Background
Erhält oder setzt die Hintergrundfarbe des Dokuments.
public Color Background { get; set; }
Eigenschaftswert
Color
CenterWindow
Erhält oder setzt das Flag, das angibt, ob die Position des Fensters des Dokuments zentriert auf dem Bildschirm sein soll.
public bool CenterWindow { get; set; }
Eigenschaftswert
Beispiele
Beispiel zeigt, wie man das CenterWindow-Flag erhält:
Document document = new Document("sample.pdf");
bool value = document.CenterWindow;
Collection
Erhält die Sammlung des Dokuments.
public Collection Collection { get; set; }
Eigenschaftswert
Collection
CryptoAlgorithm
Erhält die Sicherheitseinstellungen, wenn das Dokument verschlüsselt ist. Wenn das Dokument nicht verschlüsselt ist, wird die entsprechende Ausnahme in .net 1.1 ausgelöst oder CryptoAlgorithm ist null für andere .net-Versionen.
public CryptoAlgorithm? CryptoAlgorithm { get; }
Eigenschaftswert
CryptoAlgorithm?
Destinations
Erhält die Sammlung von Zielen. Veraltet. Bitte verwenden Sie NamedDestinations.
public DestinationCollection Destinations { get; }
Eigenschaftswert
DestinationCollection
Direction
Erhält oder setzt die Lesereihenfolge des Textes: L2R (von links nach rechts) oder R2L (von rechts nach links).
public Direction Direction { get; set; }
Eigenschaftswert
Direction
DisableFontLicenseVerifications
Viele Operationen mit Schriftarten können nicht ausgeführt werden, wenn diese Operationen durch die Lizenz dieser Schriftart untersagt sind. Beispielsweise kann eine Schriftart nicht in ein PDF-Dokument eingebettet werden, wenn die Lizenzregeln das Einbetten dieser Schriftart deaktivieren. Dieses Flag wird verwendet, um alle Lizenzbeschränkungen für alle Schriftarten im aktuellen PDF-Dokument zu deaktivieren. Seien Sie vorsichtig bei der Verwendung dieses Flags. Wenn es gesetzt ist, bedeutet dies, dass die Person, die dieses Flag setzt, die gesamte Verantwortung für mögliche Lizenz-/Gesetzesverstöße übernimmt. Das bedeutet, dass sie es auf eigenes Risiko tut. Es wird dringend empfohlen, dieses Flag nur zu verwenden, wenn Sie sich vollständig sicher sind, dass Sie das Urheberrecht nicht verletzen. Standardmäßig false.
public bool DisableFontLicenseVerifications { get; set; }
Eigenschaftswert
DisplayDocTitle
Erhält oder setzt das Flag, das angibt, ob die Titelleiste des Fensters des Dokuments den Dokumenttitel anzeigen soll.
public bool DisplayDocTitle { get; set; }
Eigenschaftswert
Beispiele
Beispiel zeigt, wie man das DisplayDocTitle-Flag erhält:
Document document = new Document("sample.pdf");
bool value = document.DisplayDocTitle;
Duplex
Erhält oder setzt die Druckduplexmodusbehandlungsoption, die beim Drucken der Datei im Druckdialog verwendet werden soll.
public PrintDuplex Duplex { get; set; }
Eigenschaftswert
PrintDuplex
EmbedStandardFonts
Eigenschaft, die erklärt, dass das Dokument alle Standard-Type1-Schriftarten einbetten muss, die das Flag IsEmbedded auf true gesetzt haben. Alle PDF-Schriftarten können in das Dokument eingebettet werden, indem das Flag IsEmbedded auf true gesetzt wird, aber PDF-Standard-Type1-Schriftarten sind eine Ausnahme von dieser Regel. Das Einbetten von Standard-Type1-Schriftarten erfordert viel Zeit, daher ist es notwendig, nicht nur das Flag IsEmbedded auf true für die angegebene Schriftart zu setzen, sondern auch ein zusätzliches Flag auf Dokumentebene - EmbedStandardFonts = true; Diese Eigenschaft kann nur einmal für alle Schriftarten gesetzt werden. Standardmäßig false.
public bool EmbedStandardFonts { get; set; }
Eigenschaftswert
EmbeddedFiles
Erhält die Sammlung von in das Dokument eingebetteten Dateien.
public EmbeddedFileCollection EmbeddedFiles { get; }
Eigenschaftswert
EmbeddedFileCollection
EnableObjectUnload
Erhält oder setzt das Flag, das es ermöglicht, das Dokument teilweise aus dem Speicher zu entladen. Dies ermöglicht eine Verringerung des Speicherverbrauchs, kann jedoch negative Auswirkungen auf die Leistung haben.
public bool EnableObjectUnload { get; set; }
Eigenschaftswert
EnableSignatureSanitization
Erhält oder setzt das Flag zur Verwaltung der Sanitärbehandlung von Signaturfeldern. Standardmäßig aktiviert.
public bool EnableSignatureSanitization { get; set; }
Eigenschaftswert
FileName
Name der PDF-Datei, die dieses Dokument verursacht hat.
public string FileName { get; }
Eigenschaftswert
FitWindow
Erhält oder setzt das Flag, das angibt, ob das Dokumentfenster so angepasst werden muss, dass es zur ersten angezeigten Seite passt.
public bool FitWindow { get; set; }
Eigenschaftswert
Beispiele
Beispiel zeigt, wie man das FitWindow-Flag erhält:
Document document = new Document("sample.pdf");
bool value = document.FitWindow;
FontUtilities
IDocumentFontUtilities-Instanz
public Document.IDocumentFontUtilities FontUtilities { get; }
Eigenschaftswert
Document.IDocumentFontUtilities
Form
Erhält das Acro-Formular des Dokuments.
public Form Form { get; }
Eigenschaftswert
Form
HandleSignatureChange
Wirft eine Ausnahme, wenn das Dokument mit Änderungen gespeichert wird und eine Signatur hat.
public bool HandleSignatureChange { get; set; }
Eigenschaftswert
HideMenubar
Erhält oder setzt das Flag, das angibt, ob die Menüleiste ausgeblendet werden soll, wenn das Dokument aktiv ist.
public bool HideMenubar { get; set; }
Eigenschaftswert
Beispiele
Beispiel zeigt, wie man das HideMenubar-Flag erhält:
Document document = new Document("sample.pdf");
bool value = document.HideMenubar;
HideToolBar
Erhält oder setzt das Flag, das angibt, ob die Symbolleiste ausgeblendet werden soll, wenn das Dokument aktiv ist.
public bool HideToolBar { get; set; }
Eigenschaftswert
Beispiele
Beispiel zeigt, wie man das HideToolBar-Flag erhält:
Document document = new Document("sample.pdf");
bool value = document.HideToolBar;
HideWindowUI
Erhält oder setzt das Flag, das angibt, ob die Benutzeroberflächenelemente ausgeblendet werden sollen, wenn das Dokument aktiv ist.
public bool HideWindowUI { get; set; }
Eigenschaftswert
Beispiele
Beispiel zeigt, wie man das HideWindowUI-Flag erhält:
Document document = new Document("sample.pdf");
bool value = document.HideWindowUI;
Id
Erhält die ID.
public Id Id { get; }
Eigenschaftswert
Id
IgnoreCorruptedObjects
Erhält oder setzt das Flag zum Ignorieren von Fehlern in Quelldateien. Wenn Seiten aus dem Quell-Dokument in das Ziel-Dokument kopiert werden, wird der Kopiervorgang mit einer Ausnahme gestoppt, wenn einige Objekte in den Quelldateien beschädigt sind, wenn dieses Flag false ist. Beispiel: dest.Pages.Add(src.Pages); Wenn dieses Flag auf true gesetzt ist, werden beschädigte Objekte durch leere Werte ersetzt. Standardmäßig: true.
public bool IgnoreCorruptedObjects { get; set; }
Eigenschaftswert
Info
Erhält die Dokumentinformationen.
public DocumentInfo Info { get; }
Eigenschaftswert
DocumentInfo
IsEncrypted
Erhält den Verschlüsselungsstatus des Dokuments. Wahr, wenn das Dokument verschlüsselt ist.
public bool IsEncrypted { get; }
Eigenschaftswert
IsLicensed
Erhält den Lizenzstatus des Systems. Gibt true zurück, wenn das System im lizenzierten Modus arbeitet, andernfalls false.
public static bool IsLicensed { get; }
Eigenschaftswert
IsLinearized
Erhält oder setzt einen Wert, der angibt, ob das Dokument linearisiert ist.
public bool IsLinearized { get; set; }
Eigenschaftswert
IsPdfUaCompliant
Erhält, ob das Dokument pdfua-konform ist.
public bool IsPdfUaCompliant { get; }
Eigenschaftswert
IsPdfaCompliant
Erhält, ob das Dokument pdfa-konform ist.
public bool IsPdfaCompliant { get; }
Eigenschaftswert
IsXrefGapsAllowed
Erhält oder setzt, ob im Dokument Lücken in der Xref erlaubt sind.
public bool IsXrefGapsAllowed { get; set; }
Eigenschaftswert
JavaScript
Sammlung von JavaScript auf Dokumentebene.
public JavaScriptCollection JavaScript { get; }
Eigenschaftswert
JavaScriptCollection
LogicalStructure
Erhält die logische Struktur des Dokuments.
public RootElement LogicalStructure { get; }
Eigenschaftswert
RootElement
Metadata
Dokumentmetadaten. (Ein PDF-Dokument kann allgemeine Informationen enthalten, wie den Titel des Dokuments, den Autor sowie Erstellungs- und Änderungsdaten. Solche globalen Informationen über das Dokument (im Gegensatz zu seinem Inhalt oder seiner Struktur) werden als Metadaten bezeichnet und sollen bei der Katalogisierung und Suche nach Dokumenten in externen Datenbanken helfen.)
public Metadata Metadata { get; }
Eigenschaftswert
Metadata
NamedDestinations
Sammlung von benannten Zielen im Dokument.
public NamedDestinationCollection NamedDestinations { get; }
Eigenschaftswert
NamedDestinationCollection
NonFullScreenPageMode
Erhält oder setzt den Seitenmodus, der angibt, wie das Dokument beim Verlassen des Vollbildmodus angezeigt werden soll.
public PageMode NonFullScreenPageMode { get; set; }
Eigenschaftswert
PageMode
OpenAction
Erhält oder setzt die Aktion, die beim Öffnen des Dokuments ausgeführt wird.
public IAppointment OpenAction { get; set; }
Eigenschaftswert
IAppointment
Beispiele
Beispiel zeigt, wie man das CenterWindow-Flag erhält:
Document document = new Document("sample.pdf");
IAppointment value = document.OpenAction;
OptimizeSize
Erhält oder setzt das Optimierungsflag. Wenn Seiten zum Dokument hinzugefügt werden, werden gleiche Ressourcenströme in der resultierenden Datei in ein PDF-Objekt zusammengeführt, wenn dieses Flag gesetzt ist. Dies ermöglicht eine Verringerung der resultierenden Dateigröße, kann jedoch zu langsamerer Ausführung und höheren Speicheranforderungen führen. Standardwert: false.
public bool OptimizeSize { get; set; }
Eigenschaftswert
Outlines
Erhält die Umrisse des Dokuments.
public OutlineCollection Outlines { get; }
Eigenschaftswert
OutlineCollection
OutputIntents
Erhält die Sammlung von Ausgabeabsichten im Dokument.
public OutputIntents OutputIntents { get; }
Eigenschaftswert
OutputIntents
PageInfo
Erhält oder setzt die Seiteninformationen. (nur für Generator, nicht ausgefüllt beim Lesen des Dokuments)
public PageInfo PageInfo { get; set; }
Eigenschaftswert
PageInfo
PageLabels
Erhält die Seitenbeschriftungen im Dokument.
public PageLabelCollection PageLabels { get; }
Eigenschaftswert
PageLabelCollection
PageLayout
Erhält oder setzt das Seitenlayout, das beim Öffnen des Dokuments verwendet werden soll.
public PageLayout PageLayout { get; set; }
Eigenschaftswert
PageLayout
PageMode
Erhält oder setzt den Seitenmodus, der angibt, wie das Dokument beim Öffnen angezeigt werden soll.
public PageMode PageMode { get; set; }
Eigenschaftswert
PageMode
Pages
Erhält oder setzt die Sammlung von Dokumentseiten. Beachten Sie, dass die Seiten in der Sammlung von 1 nummeriert sind.
public PageCollection Pages { get; }
Eigenschaftswert
PageCollection
Beispiele
Das folgende Beispiel zeigt, wie man mit den Seiten des Dokuments arbeitet: Wie man die Anzahl der Seiten erhält und wie man das Rechteck der ersten Seite des Dokuments erhält.
Aspose.Pdf.Document document = new Aspose.Pdf.Document("sample.pdf");
Aspose.Pdf.PageCollection pages = document.Pages;
System.Console.WriteLine("Das Dokument enthält " + pages.Count);
Page page = pages[1];
Rectangle rect = page.Rect;
PdfFormat
Erhält das PDF-Format.
public PdfFormat PdfFormat { get; }
Eigenschaftswert
PdfFormat
Permissions
Erhält die Berechtigungen des Dokuments.
public int Permissions { get; }
Eigenschaftswert
PickTrayByPdfSize
Erhält oder setzt ein Flag, das angibt, ob die PDF-Seitengröße verwendet werden soll, um das Eingabepapierfach auszuwählen.
public bool PickTrayByPdfSize { get; set; }
Eigenschaftswert
PrintScaling
Erhält oder setzt die Seitenvergrößerungsoption, die ausgewählt werden soll, wenn ein Druckdialog für dieses Dokument angezeigt wird.
public PrintScaling PrintScaling { get; set; }
Eigenschaftswert
PrintScaling
TaggedContent
Erhält Zugriff auf den TaggedPdf-Inhalt.
public ITaggedContent TaggedContent { get; }
Eigenschaftswert
ITaggedContent
Beispiele
Das Beispiel zeigt, wie man den getaggten Inhalt verwendet, um ein neues Dokument mit Kopfzeilen, Absätzen und Bildern zu erstellen.
// Erstellen eines neuen Dokuments
Document document = new Document();
// Zugriff auf den getaggten Inhalt
ITaggedContent taggedContent = document.TaggedContent;
// Sprache für das Dokument festlegen
taggedContent.SetLanguage("de-DE");
// Titel für das PDF-Dokument festlegen
taggedContent.SetTitle("Beispieldokument");
// Erstellen und Hinzufügen einer Sektion
SectElement sect = taggedContent.CreateSectElement();
taggedContent.RootElement.AppendChild(sect);
// Erstellen der Kopfzeile
HeaderElement h1 = taggedContent.CreateHeaderElement(1);
h1.SetText("Die Kopfzeile");
sect.AppendChild(h1);
// Erstellen des Absatzes
ParagraphElement p = taggedContent.CreateParagraphElement();
p.SetTag("Paragraph");
p.SetText("Der Text des Absatzes.");
sect.AppendChild(p);
// Erstellen der Abbildung
IllustrationElement figure1 = taggedContent.CreateFigureElement();
sect.AppendChild(figure1);
figure1.AlternativeText = "Abbildung 1";
figure1.Title = "Bild 1";
figure1.SetTag("Fig");
figure1.SetImage("path/of/image.jpg");
// Dokument speichern
document.Save("beispiel.pdf");
Version
Erhält eine Version von PDF aus dem PDF-Dateikopf.
public string Version { get; }
Eigenschaftswert
Methoden
BindXml(string)
Bindet XML an das Dokument.
public void BindXml(string file)
Parameter
file
string
Die XML-Datei.
BindXml(string, string)
Bindet XML/XSL an das Dokument.
public void BindXml(string xmlFile, string xslFile)
Parameter
xmlFile
string
Die XML-Datei.
xslFile
string
Die XSL-Datei, wenn XSLT verwendet wird.
BindXml(Stream, Stream)
Bindet XML/XSL an das Dokument.
public void BindXml(Stream xmlStream, Stream xslStream)
Parameter
xmlStream
Stream
Der XML-Stream.
xslStream
Stream
Der XSL-Stream, wenn XSLT verwendet wird.
BindXml(Stream, Stream, XmlReaderSettings)
Bindet XML/XSL an das Dokument.
public void BindXml(Stream xmlStream, Stream xslStream, XmlReaderSettings settings)
Parameter
xmlStream
Stream
Der XML-Stream.
xslStream
Stream
Der XSL-Stream, wenn XSLT verwendet wird.
settings
XmlReaderSettings
Die XML-Leseeinstellungen.
BindXml(Stream)
Bindet XML an das Dokument.
public void BindXml(Stream stream)
Parameter
stream
Stream
Der XML-Stream.
ChangePasswords(string, string, string)
Ändert die Passwörter des Dokuments. Diese Aktion kann nur mit dem Eigentümerpasswort durchgeführt werden.
public void ChangePasswords(string ownerPassword, string newUserPassword, string newOwnerPassword)
Parameter
ownerPassword
string
Eigentümerpasswort.
newUserPassword
string
Neues Benutzerpasswort.
newOwnerPassword
string
Neues Eigentümerpasswort.
Check(bool)
Validiert das Dokument.
public bool Check(bool doRepair)
Parameter
doRepair
bool
Wenn true, werden gefundene Probleme repariert.
Gibt zurück
Wahr - wenn das Dokument repariert wurde; andernfalls falsch.
Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Konvertiert das Dokument und speichert Fehler in der angegebenen Datei.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
Parameter
outputLogFileName
string
Pfad zur Datei, in der die Kommentare gespeichert werden.
format
PdfFormat
Das PDF-Format.
action
ConvertErrorAction
Aktion für Objekte, die nicht konvertiert werden können.
transparencyAction
ConvertTransparencyAction
Aktion für bildmaskierte Objekte.
Gibt zurück
Das Ergebnis der Operation.
Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Konvertiert das Dokument und speichert Fehler in der angegebenen Datei.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
Parameter
outputLogStream
Stream
Stream, in dem die Kommentare gespeichert werden.
format
PdfFormat
Das PDF-Format.
action
ConvertErrorAction
Aktion für Objekte, die nicht konvertiert werden können.
transparencyAction
ConvertTransparencyAction
Aktion für bildmaskierte Objekte.
Gibt zurück
Das Ergebnis der Operation.
Convert(string, PdfFormat, ConvertErrorAction)
Konvertiert das Dokument und speichert Fehler in der angegebenen Datei.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action)
Parameter
outputLogFileName
string
Pfad zur Datei, in der die Kommentare gespeichert werden.
format
PdfFormat
Das PDF-Format.
action
ConvertErrorAction
Aktion für Objekte, die nicht konvertiert werden können.
Gibt zurück
Das Ergebnis der Operation.
Convert(PdfFormatConversionOptions)
Konvertiert das Dokument mit den angegebenen Konvertierungsoptionen.
public bool Convert(PdfFormatConversionOptions options)
Parameter
options
PdfFormatConversionOptions
Set von Optionen zur Konvertierung des PDF-Dokuments.
Gibt zurück
Das Ergebnis der Operation.
Convert(CallBackGetHocrWithPage, bool)
Erkennt Bilder im Dokument und fügt hocr-Strings darüber hinzu.
public bool Convert(Document.CallBackGetHocrWithPage callback, bool flattenImages = false)
Parameter
callback
Document.CallBackGetHocrWithPage
Aktion für Bilder, die von hocr erkannt werden sollen.
flattenImages
bool
Text in PDF-Bildern kann mit Hilfe von Masken gezeichnet werden, in diesem Fall müssen die Bilder abgeflacht werden.
Gibt zurück
Das Ergebnis der Operation. Wenn im Dokument keine Bilder vorhanden sind, wird false zurückgegeben.
Convert(CallBackGetHocr, bool)
Erkennt Bilder im Dokument und fügt hocr-Strings darüber hinzu.
public bool Convert(Document.CallBackGetHocr callback, bool flattenImages = false)
Parameter
callback
Document.CallBackGetHocr
Aktion für Bilder, die von hocr erkannt werden sollen.
flattenImages
bool
Text in PDF-Bildern kann mit Hilfe von Masken gezeichnet werden, in diesem Fall müssen die Bilder abgeflacht werden.
Gibt zurück
Das Ergebnis der Operation. Wenn im Dokument keine Bilder vorhanden sind, wird false zurückgegeben.
Convert(Stream, PdfFormat, ConvertErrorAction)
Konvertiert das Dokument und speichert Fehler in dem angegebenen Stream.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action)
Parameter
outputLogStream
Stream
Stream, in dem die Kommentare gespeichert werden.
format
PdfFormat
PDF-Format.
action
ConvertErrorAction
Aktion für Objekte, die nicht konvertiert werden können.
Gibt zurück
Das Ergebnis der Operation.
Convert(Fixup, Stream, bool, object[])
Konvertiert das Dokument, indem das Fixup angewendet wird.
public bool Convert(Fixup fixup, Stream outputLog, bool onlyValidation = false, object[] parameters = null)
Parameter
fixup
Fixup
Der Fixup-Typ.
outputLog
Stream
Das Protokoll des Prozesses.
onlyValidation
bool
Nur Dokumentvalidierung.
parameters
object[]
Eigenschaften für Fixup, die nicht gesetzt werden können.
Gibt zurück
Das Ergebnis der Operation.
Convert(Fixup, string, bool, object[])
Konvertiert das Dokument, indem das Fixup angewendet wird.
public bool Convert(Fixup fixup, string outputLog, bool onlyValidation = false, object[] parameters = null)
Parameter
fixup
Fixup
Der Fixup-Typ.
outputLog
string
Das Protokoll des Prozesses.
onlyValidation
bool
Nur Dokumentvalidierung.
parameters
object[]
Eigenschaften für Fixup, die nicht gesetzt werden können.
Gibt zurück
Das Ergebnis der Operation.
Convert(string, LoadOptions, string, SaveOptions)
Konvertiert die Quelldatei im Quellformat in die Zieldatei im Zielformat.
public static void Convert(string srcFileName, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)
Parameter
srcFileName
string
Der Name der Quelldatei.
loadOptions
LoadOptions
Das Quelldateiformat.
dstFileName
string
Der Name der Zieldatei.
saveOptions
SaveOptions
Das Zielformat der Datei.
Convert(Stream, LoadOptions, string, SaveOptions)
Konvertiert den Stream im Quellformat in die Zieldatei im Zielformat.
public static void Convert(Stream srcStream, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)
Parameter
srcStream
Stream
Der Quellstream.
loadOptions
LoadOptions
Das Quellstreamformat.
dstFileName
string
Der Name der Zieldatei.
saveOptions
SaveOptions
Das Zielformat der Datei.
Convert(string, LoadOptions, Stream, SaveOptions)
Konvertiert die Quelldatei im Quellformat in den Stream im Zielformat.
public static void Convert(string srcFileName, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)
Parameter
srcFileName
string
Der Name der Quelldatei.
loadOptions
LoadOptions
Das Quelldateiformat.
dstStream
Stream
Der Zielstream.
saveOptions
SaveOptions
Das Zielformat der Stream.
Convert(Stream, LoadOptions, Stream, SaveOptions)
Konvertiert den Stream im Quellformat in den Stream im Zielformat.
public static void Convert(Stream srcStream, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)
Parameter
srcStream
Stream
Der Quellstream.
loadOptions
LoadOptions
Das Quellstreamformat.
dstStream
Stream
Der Zielstream.
saveOptions
SaveOptions
Das Zielformat der Datei.
ConvertPageToPNGMemoryStream(Page)
Konvertiert die Seite in PNG für DSR, OMR, OCR-Bildstream.
public MemoryStream ConvertPageToPNGMemoryStream(Page page)
Parameter
page
Page
Seite, die konvertiert werden soll.
Gibt zurück
Bildstream.
Decrypt()
Entschlüsselt das Dokument. Rufen Sie dann Speichern auf, um die entschlüsselte Version des Dokuments zu erhalten.
public void Decrypt()
Dispose()
Schließt alle Ressourcen, die von diesem Dokument verwendet werden.
public void Dispose()
Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool)
Verschlüsselt das Dokument. Rufen Sie dann Speichern auf, um die verschlüsselte Version des Dokuments zu erhalten.
public void Encrypt(string userPassword, string ownerPassword, DocumentPrivilege privileges, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)
Parameter
userPassword
string
Benutzerpasswort.
ownerPassword
string
Eigentümerpasswort.
privileges
DocumentPrivilege
Dokumentenberechtigungen, siehe Aspose.Pdf.Document.Permissions für Details.
cryptoAlgorithm
CryptoAlgorithm
Kryptografischer Algorithmus, siehe Aspose.Pdf.Document.CryptoAlgorithm für Details.
usePdf20
bool
Unterstützung für Revision 6 (Erweiterung 8).
Encrypt(string, string, Permissions, CryptoAlgorithm)
Verschlüsselt das Dokument. Rufen Sie dann Speichern auf, um die verschlüsselte Version des Dokuments zu erhalten.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm)
Parameter
userPassword
string
Benutzerpasswort.
ownerPassword
string
Eigentümerpasswort.
permissions
Permissions
Dokumentenberechtigungen, siehe Aspose.Pdf.Document.Permissions für Details.
cryptoAlgorithm
CryptoAlgorithm
Kryptografischer Algorithmus, siehe Aspose.Pdf.Document.CryptoAlgorithm für Details.
Encrypt(string, string, Permissions, CryptoAlgorithm, bool)
Verschlüsselt das Dokument. Rufen Sie dann Speichern auf, um die verschlüsselte Version des Dokuments zu erhalten.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)
Parameter
userPassword
string
Benutzerpasswort.
ownerPassword
string
Eigentümerpasswort.
permissions
Permissions
Dokumentenberechtigungen, siehe Aspose.Pdf.Document.Permissions für Details.
cryptoAlgorithm
CryptoAlgorithm
Kryptografischer Algorithmus, siehe Aspose.Pdf.Document.CryptoAlgorithm für Details.
usePdf20
bool
Unterstützung für Revision 6 (Erweiterung 8).
ExportAnnotationsToXfdf(string)
Exportiert alle Dokumentanmerkungen in eine XFDF-Datei.
public void ExportAnnotationsToXfdf(string fileName)
Parameter
fileName
string
XFDF-Dateiname.
ExportAnnotationsToXfdf(Stream)
Exportiert alle Dokumentanmerkungen in einen Stream.
public void ExportAnnotationsToXfdf(Stream stream)
Parameter
stream
Stream
Stream, in dem XFDF gespeichert wird.
Flatten()
Entfernt alle Felder aus dem Dokument und platziert deren Werte anstelle von ihnen.
public void Flatten()
Flatten(FlattenSettings)
Entfernt alle Felder (und Anmerkungen) aus dem Dokument und platziert deren Werte anstelle von ihnen.
public void Flatten(Form.FlattenSettings flattenSettings)
Parameter
flattenSettings
Form.FlattenSettings
Einstellungen für den Flatten-Prozess.
FlattenTransparency()
Ersetzt transparente Inhalte durch nicht-transparente Raster- und Vektorgrafiken.
public void FlattenTransparency()
FreeMemory()
Löscht den Speicher.
public void FreeMemory()
GetCatalogValue(string)
Gibt den Wert eines Elements aus dem Katalogwörterbuch zurück.
public object GetCatalogValue(string key)
Parameter
key
string
Der Schlüssel des Elements.
Gibt zurück
Elementwert - wenn der Schlüssel erfolgreich gefunden wurde; andernfalls null.
GetObjectById(string)
Erhält ein Objekt mit der angegebenen ID im Dokument.
public object GetObjectById(string id)
Parameter
id
string
Die Objekt-ID.
Gibt zurück
Das Objekt mit der angegebenen ID. Null, wenn die ID nicht gefunden wurde.
GetXmpMetadata(Stream)
Erhält die XMP-Metadaten aus dem Dokument.
public void GetXmpMetadata(Stream stream)
Parameter
stream
Stream
Stream, in dem die Metadaten gespeichert werden.
HasIncrementalUpdate()
Überprüft, ob das aktuelle PDF-Dokument mit inkrementellen Updates gespeichert wurde.
public bool HasIncrementalUpdate()
Gibt zurück
true
, wenn das PDF-Dokument inkrementelle Updates hat; andernfalls false
.
ImportAnnotationsFromXfdf(string)
Importiert Anmerkungen aus der XFDF-Datei in das Dokument.
public void ImportAnnotationsFromXfdf(string fileName)
Parameter
fileName
string
XFDF-Dateiname.
ImportAnnotationsFromXfdf(Stream)
Importiert Anmerkungen aus dem Stream in das Dokument.
public void ImportAnnotationsFromXfdf(Stream stream)
Parameter
stream
Stream
Stream, der XFDF-Daten enthält.
LoadFrom(string, LoadOptions)
Lädt eine Datei und konvertiert sie in PDF.
public void LoadFrom(string filename, LoadOptions options)
Parameter
filename
string
Der Pfad zur zu öffnenden Datei.
options
LoadOptions
Die Ladeoptionen.
Ausnahmen
PdfException
Wenn die Datei nicht geladen werden kann.
Wenn die Datei nicht gefunden wird.
Merge(MergeOptions, params Document[])
Vereint Dokumente.
public void Merge(Document.MergeOptions mergeOptions, params Document[] documents)
Parameter
mergeOptions
Document.MergeOptions
Die Zusammenführungsoptionen.
documents
Document[]
Die zu vereinigenden Dokumente.
Merge(MergeOptions, params string[])
Vereint Dokumente.
public void Merge(Document.MergeOptions mergeOptions, params string[] files)
Parameter
mergeOptions
Document.MergeOptions
Die Zusammenführungsoptionen.
files
string[]
Die PDF-Dateien, die zusammengeführt werden sollen.
Merge(params Document[])
Vereint Dokumente.
public void Merge(params Document[] documents)
Parameter
documents
Document[]
Die zu vereinigenden Dokumente.
Merge(params string[])
Vereint PDF-Dateien.
public void Merge(params string[] files)
Parameter
files
string[]
Die PDF-Dateien, die zusammengeführt werden sollen.
MergeDocuments(MergeOptions, params string[])
Vereint Dokumente.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params string[] files)
Parameter
mergeOptions
Document.MergeOptions
Die Zusammenführungsoptionen.
files
string[]
Die PDF-Dateien, die zusammengeführt werden sollen.
Gibt zurück
Das zusammengeführte Dokument.
MergeDocuments(MergeOptions, params Document[])
Vereint Dokumente.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params Document[] files)
Parameter
mergeOptions
Document.MergeOptions
files
Document[]
Die zu vereinigenden Dokumente.
Gibt zurück
Das zusammengeführte Dokument.
MergeDocuments(params string[])
Vereint PDF-Dateien.
public static Document MergeDocuments(params string[] files)
Parameter
files
string[]
Die PDF-Dateien, die zusammengeführt werden sollen.
Gibt zurück
Das zusammengeführte Dokument.
MergeDocuments(params Document[])
Vereint Dokumente.
public static Document MergeDocuments(params Document[] documents)
Parameter
documents
Document[]
Die zu vereinigenden Dokumente.
Gibt zurück
Das zusammengeführte Dokument.
Optimize()
Linearisiert das Dokument, um:
- die erste Seite so schnell wie möglich zu öffnen;
- die nächste Seite oder den Link zur nächsten Seite so schnell wie möglich anzuzeigen;
- die Seite inkrementell anzuzeigen, während sie ankommt, wenn die Daten für eine Seite über einen langsamen Kanal geliefert werden (die nützlichsten Daten zuerst anzeigen);
- Benutzereingaben zu ermöglichen, wie das Folgen eines Links, auch bevor die gesamte Seite empfangen und angezeigt wurde. Das Aufrufen dieser Methode speichert das Dokument nicht tatsächlich. Im Gegenteil, das Dokument wird nur vorbereitet, um eine optimierte Struktur zu haben, rufen Sie dann Speichern auf, um das optimierte Dokument zu erhalten.
public void Optimize()
OptimizeResources()
Optimiert die Ressourcen im Dokument:
- Ressourcen, die auf den Dokumentseiten nicht verwendet werden, werden entfernt;
- Gleiche Ressourcen werden in ein Objekt zusammengeführt;
- Unbenutzte Objekte werden gelöscht.
public void OptimizeResources()
OptimizeResources(OptimizationOptions)
Optimiert die Ressourcen im Dokument gemäß der definierten Optimierungsstrategie.
public void OptimizeResources(OptimizationOptions strategy)
Parameter
strategy
OptimizationOptions
Optimierungsstrategie.
PageNodesToBalancedTree(byte)
Organisiert die Seitenbaumknoten in einem Dokument in einen ausgewogenen Baum. Nur wenn das Dokument mehr als nodesNumInSubtrees Seitenobjekte hat, ansonsten tut es nichts. Rufen Sie diese Methode nicht auf, während Sie über die Seiten-Elemente iterieren, da dies unvorhersehbare Ergebnisse liefern kann.
public void PageNodesToBalancedTree(byte nodesNumInSubtrees = 10)
Parameter
nodesNumInSubtrees
byte
Gewünschte Anzahl von Unterknoten. Standardwert ist zehn.
ProcessParagraphs()
Verarbeitet Absätze für den Generator.
public void ProcessParagraphs()
RemoveMetadata()
Entfernt Metadaten aus dem Dokument.
public void RemoveMetadata()
RemovePdfUaCompliance()
Entfernt die pdfUa-Konformität aus dem Dokument.
public void RemovePdfUaCompliance()
RemovePdfaCompliance()
Entfernt die pdfa-Konformität aus dem Dokument.
public void RemovePdfaCompliance()
Repair()
Repariert ein beschädigtes Dokument.
public void Repair()
Save(Stream)
Speichert das Dokument im Stream.
public void Save(Stream output)
Parameter
output
Stream
Stream, in dem das Dokument gespeichert werden soll.
Save(string)
Speichert das Dokument in der angegebenen Datei.
public void Save(string outputFileName)
Parameter
outputFileName
string
Pfad zur Datei, in der das Dokument gespeichert werden soll.
Save()
Speichert das Dokument inkrementell (d.h. mit der Technik des inkrementellen Updates).
public void Save()
Bemerkungen
Um das Dokument inkrementell zu speichern, müssen wir die Dokumentdatei zum Schreiben öffnen. Daher muss das Dokument mit einem beschreibbaren Stream wie im folgenden Code-Snippet initialisiert werden: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // Änderungen vornehmen und das Dokument inkrementell speichern doc.Save();
Save(SaveOptions)
Speichert das Dokument mit Speichereinstellungen.
public void Save(SaveOptions options)
Parameter
options
SaveOptions
Speichereinstellungen.
Save(string, SaveFormat)
Speichert das Dokument mit einem neuen Namen zusammen mit einem Dateiformat.
public void Save(string outputFileName, SaveFormat format)
Parameter
outputFileName
string
Pfad zur Datei, in der das Dokument gespeichert werden soll.
format
SaveFormat
Formatoptionen.
Save(Stream, SaveFormat)
Speichert das Dokument mit einem neuen Namen zusammen mit einem Dateiformat.
public void Save(Stream outputStream, SaveFormat format)
Parameter
outputStream
Stream
Stream, in dem das Dokument gespeichert werden soll.
format
SaveFormat
Formatoptionen.
Ausnahmen
System.ArgumentException, wenn Aspose.Pdf.HtmlSaveOptions an eine Methode übergeben wird. Das Speichern eines Dokuments im HTML-Stream wird nicht unterstützt. Bitte verwenden Sie die Methode, um die Datei zu speichern.
Save(string, SaveOptions)
Speichert das Dokument mit einem neuen Namen und legt seine Speichereinstellungen fest.
public void Save(string outputFileName, SaveOptions options)
Parameter
outputFileName
string
Pfad zur Datei, in der das Dokument gespeichert werden soll.
options
SaveOptions
Speichereinstellungen.
Save(Stream, SaveOptions)
Speichert das Dokument in einem Stream mit Speichereinstellungen.
public void Save(Stream outputStream, SaveOptions options)
Parameter
outputStream
Stream
Stream, in dem das Dokument gespeichert werden soll.
options
SaveOptions
Speichereinstellungen.
Ausnahmen
System.ArgumentException, wenn Aspose.Pdf.HtmlSaveOptions an eine Methode übergeben wird. Das Speichern eines Dokuments im HTML-Stream wird nicht unterstützt. Bitte verwenden Sie die Methode, um die Datei zu speichern.
SaveAsync(Stream, CancellationToken)
Speichert das Dokument im Stream.
public Task SaveAsync(Stream output, CancellationToken cancellationToken)
Parameter
output
Stream
Stream, in dem das Dokument gespeichert werden soll.
cancellationToken
CancellationToken
Abbruch-Token.
Gibt zurück
Asynchrone Aufgabe.
SaveAsync(string, CancellationToken)
Speichert das Dokument in der angegebenen Datei.
public Task SaveAsync(string outputFileName, CancellationToken cancellationToken)
Parameter
outputFileName
string
Pfad zur Datei, in der das Dokument gespeichert werden soll.
cancellationToken
CancellationToken
Abbruch-Token.
Gibt zurück
Asynchrone Aufgabe.
SaveAsync(CancellationToken)
Speichert das Dokument inkrementell (d.h. mit der Technik des inkrementellen Updates).
public Task SaveAsync(CancellationToken cancellationToken)
Parameter
cancellationToken
CancellationToken
Abbruch-Token.
Gibt zurück
Asynchrone Aufgabe.
Bemerkungen
Um das Dokument inkrementell zu speichern, müssen wir die Dokumentdatei zum Schreiben öffnen. Daher muss das Dokument mit einem beschreibbaren Stream wie im folgenden Code-Snippet initialisiert werden: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // Änderungen vornehmen und das Dokument inkrementell speichern doc.Save();
SaveAsync(SaveOptions, CancellationToken)
Speichert das Dokument mit Speichereinstellungen.
public Task SaveAsync(SaveOptions options, CancellationToken cancellationToken)
Parameter
options
SaveOptions
Speichereinstellungen.
cancellationToken
CancellationToken
Abbruch-Token.
Gibt zurück
Asynchrone Aufgabe.
SaveAsync(string, SaveFormat, CancellationToken)
Speichert das Dokument mit einem neuen Namen zusammen mit einem Dateiformat.
public Task SaveAsync(string outputFileName, SaveFormat format, CancellationToken cancellationToken)
Parameter
outputFileName
string
Pfad zur Datei, in der das Dokument gespeichert werden soll.
format
SaveFormat
Formatoptionen.
cancellationToken
CancellationToken
Abbruch-Token.
Gibt zurück
Asynchrone Aufgabe.
SaveAsync(Stream, SaveFormat, CancellationToken)
Speichert das Dokument mit einem neuen Namen zusammen mit einem Dateiformat.
public Task SaveAsync(Stream outputStream, SaveFormat format, CancellationToken cancellationToken)
Parameter
outputStream
Stream
Stream, in dem das Dokument gespeichert werden soll.
format
SaveFormat
Formatoptionen.
cancellationToken
CancellationToken
Abbruch-Token.
Gibt zurück
Asynchrone Aufgabe.
Ausnahmen
System.ArgumentException, wenn Aspose.Pdf.HtmlSaveOptions an eine Methode übergeben wird. Das Speichern eines Dokuments im HTML-Stream wird nicht unterstützt. Bitte verwenden Sie die Methode, um die Datei zu speichern.
SaveAsync(string, SaveOptions, CancellationToken)
Speichert das Dokument mit einem neuen Namen und legt seine Speichereinstellungen fest.
public Task SaveAsync(string outputFileName, SaveOptions options, CancellationToken cancellationToken)
Parameter
outputFileName
string
Pfad zur Datei, in der das Dokument gespeichert werden soll.
options
SaveOptions
Speichereinstellungen.
cancellationToken
CancellationToken
Abbruch-Token.
Gibt zurück
Asynchrone Aufgabe.
SaveAsync(Stream, SaveOptions, CancellationToken)
Speichert das Dokument in einem Stream mit Speichereinstellungen.
public Task SaveAsync(Stream outputStream, SaveOptions options, CancellationToken cancellationToken)
Parameter
outputStream
Stream
Stream, in dem das Dokument gespeichert werden soll.
options
SaveOptions
Speichereinstellungen.
cancellationToken
CancellationToken
Abbruch-Token.
Gibt zurück
Asynchrone Aufgabe.
Ausnahmen
System.ArgumentException, wenn Aspose.Pdf.HtmlSaveOptions an eine Methode übergeben wird. Das Speichern eines Dokuments im HTML-Stream wird nicht unterstützt. Bitte verwenden Sie die Methode, um die Datei zu speichern.
SaveXml(string)
Speichert das Dokument in XML.
public void SaveXml(string file)
Parameter
file
string
Die XML-Datei des Dokumentmodells.
SendTo(DocumentDevice, Stream)
Sendet das gesamte Dokument an das Dokumentgerät zur Verarbeitung.
public void SendTo(DocumentDevice device, Stream output)
Parameter
device
DocumentDevice
Dokumentgerät, das zur Verarbeitung des Dokuments verwendet wird.
output
Stream
Ausgabestream, der die Ergebnisse der Dokumentverarbeitung mit dem angegebenen Gerät enthält.