Document

Document class

Stellt ein Word-Dokument dar.

Um mehr zu erfahren, besuchen Sie dieArbeiten mit Dokument Dokumentationsartikel.

public class Document : DocumentBase

Konstrukteure

NameBeschreibung
Document()Erstellt ein leeres Word-Dokument.
Document(Stream)Öffnet ein vorhandenes Dokument aus einem Stream. Erkennt automatisch das Dateiformat.
Document(string)Öffnet ein vorhandenes Dokument aus einer Datei. Erkennt automatisch das Dateiformat.
Document(Stream, LoadOptions)Öffnet ein vorhandenes Dokument aus einem Stream. Ermöglicht die Angabe zusätzlicher Optionen wie z. B. eines Verschlüsselungskennworts.
Document(string, LoadOptions)Öffnet ein vorhandenes Dokument aus einer Datei. Ermöglicht die Angabe zusätzlicher Optionen wie z. B. eines Verschlüsselungskennworts.

Eigenschaften

NameBeschreibung
AttachedTemplate { get; set; }Ruft den vollständigen Pfad der an das Dokument angehängten Vorlage ab oder legt diesen fest.
AutomaticallyUpdateStyles { get; set; }Ruft ein Flag ab oder legt es fest, das angibt, ob die Stile im Dokument bei jedem Öffnen des Dokuments in MS Word so aktualisiert werden, dass sie mit den Stilen in der angehängten Vorlage übereinstimmen.
BackgroundShape { get; set; }Ruft die Hintergrundform des Dokuments ab oder legt diese fest. Kann seinNull .
BuiltInDocumentProperties { get; }Gibt eine Sammlung zurück, die alle integrierten Dokumenteigenschaften des Dokuments darstellt.
CompatibilityOptions { get; }Bietet Zugriff auf Dokumentkompatibilitätsoptionen (d. h. die Benutzereinstellungen, die im eingegeben wurden).Kompatibilität Registerkarte desOptionen Dialog in Word).
Compliance { get; }Ruft die aus dem geladenen Dokumentinhalt ermittelte OOXML-Konformitätsversion ab. Ist nur für OOXML-Dokumente sinnvoll.
Count { get; }Ruft die Anzahl der unmittelbaren Kinder dieses Knotens ab.
CustomDocumentProperties { get; }Gibt eine Sammlung zurück, die alle benutzerdefinierten Dokumenteigenschaften des Dokuments darstellt.
CustomNodeId { get; set; }Gibt die benutzerdefinierte Knotenkennung an.
CustomXmlParts { get; set; }Ruft die Sammlung benutzerdefinierter XML-Datenspeicherteile ab oder legt diese fest.
DefaultTabStop { get; set; }Ruft das Intervall (in Punkt) zwischen den Standardtabstopps ab oder legt es fest.
DigitalSignatures { get; }Ruft die Sammlung digitaler Signaturen für dieses Dokument und deren Validierungsergebnisse ab.
override Document { get; }Ruft diese Instanz ab.
EndnoteOptions { get; }Bietet Optionen, die die Nummerierung und Positionierung von Endnoten in diesem Dokument steuern.
FieldOptions { get; }Ruft a abFieldOptions Objekt, das Optionen zur Steuerung der Feldverarbeitung im Dokument darstellt.
FirstChild { get; }Ruft das erste untergeordnete Element des Knotens ab.
FirstSection { get; }Ruft den ersten Abschnitt im Dokument ab.
FontInfos { get; }Bietet Zugriff auf die Eigenschaften der in diesem Dokument verwendeten Schriftarten.
FontSettings { get; set; }Ruft Einstellungen für Dokumentschriftarten ab oder legt diese fest.
FootnoteOptions { get; }Bietet Optionen, die die Nummerierung und Positionierung von Fußnoten in diesem Dokument steuern.
Frameset { get; }Gibt a zurückFramesetBeispiel, wenn dieses Dokument eine Frames-Seite darstellt.
GlossaryDocument { get; set; }Ruft das Glossardokument in diesem Dokument oder dieser Vorlage ab oder legt es fest. Ein Glossardokument ist ein Speicher für AutoText-, AutoCorrect- und Building Block-Einträge, die in einem Dokument definiert sind.
GrammarChecked { get; set; }Gibt zurückWAHR wenn das Dokument auf Grammatik überprüft wurde.
HasChildNodes { get; }Gibt zurückWAHR wenn dieser Knoten untergeordnete Knoten hat.
HasMacros { get; }Gibt zurückWAHR wenn das Dokument ein VBA-Projekt (Makros) hat.
HasRevisions { get; }Gibt zurückWAHR ob das Dokument nachverfolgte Änderungen aufweist.
HyphenationOptions { get; }Bietet Zugriff auf Silbentrennungsoptionen für Dokumente.
IncludeTextboxesFootnotesEndnotesInStat { get; set; }Gibt an, ob Textfelder, Fußnoten und Endnoten in die Wortzahlstatistik einbezogen werden sollen.
override IsComposite { get; }Gibt zurückWAHR da dieser Knoten untergeordnete Knoten haben kann.
JustificationMode { get; set; }Ruft die Zeichenabstandsanpassung eines Dokuments ab oder legt diese fest.
LastChild { get; }Ruft das letzte untergeordnete Element des Knotens ab.
LastSection { get; }Ruft den letzten Abschnitt im Dokument ab.
LayoutOptions { get; }Ruft a abLayoutOptions Objekt, das Optionen zur Steuerung des Layoutprozesses dieses Dokuments darstellt.
Lists { get; }Bietet Zugriff auf die im Dokument verwendete Listenformatierung.
MailMerge { get; }Gibt a zurückMailMerge Objekt, das die Serienbrieffunktion für das Dokument darstellt.
MailMergeSettings { get; set; }Ruft das Objekt ab oder legt es fest, das alle Serienbriefinformationen für ein Dokument enthält.
NextSibling { get; }Ruft den Knoten ab, der diesem Knoten unmittelbar folgt.
NodeChangingCallback { get; set; }Wird aufgerufen, wenn ein Knoten in das Dokument eingefügt oder entfernt wird.
override NodeType { get; }Gibt zurückDocument .
OriginalFileName { get; }Ruft den ursprünglichen Dateinamen des Dokuments ab.
OriginalLoadFormat { get; }Ruft das Format des Originaldokuments ab, das in dieses Objekt geladen wurde.
PackageCustomParts { get; set; }Ruft die Sammlung benutzerdefinierter Teile (beliebiger Inhalt) ab oder legt diese fest, die über „unbekannte Beziehungen“ mit dem OOXML-Paket verknüpft sind.
PageColor { get; set; }Ruft die Seitenfarbe des Dokuments ab oder legt diese fest. Diese Eigenschaft ist eine einfachere Version vonBackgroundShape .
PageCount { get; }Ruft die Anzahl der Seiten im Dokument ab, wie durch den letzten Seitenlayout-Vorgang berechnet.
ParentNode { get; }Ruft das unmittelbare übergeordnete Element dieses Knotens ab.
PreviousSibling { get; }Ruft den Knoten ab, der diesem Knoten unmittelbar vorangeht.
ProtectionType { get; }Ruft den aktuell aktiven Dokumentenschutztyp ab.
Range { get; }Gibt a zurückRange Objekt, das den Teil eines Dokuments darstellt, der in diesem Knoten enthalten ist.
RemovePersonalInformation { get; set; }Ruft ein Flag ab oder setzt es, das angibt, dass Microsoft Word beim Speichern des Dokuments alle Benutzerinformationen aus Kommentaren, Überarbeitungen und Dokumenteigenschaften entfernt.
ResourceLoadingCallback { get; set; }Ermöglicht die Steuerung, wie externe Ressourcen geladen werden.
Revisions { get; }Ruft eine Sammlung von Revisionen (nachverfolgten Änderungen) ab, die in diesem Dokument vorhanden sind.
RevisionsView { get; set; }Ruft einen Wert ab oder legt diesen fest, der angibt, ob mit der Originalversion oder der überarbeiteten Version eines Dokuments gearbeitet werden soll.
Sections { get; }Gibt eine Sammlung zurück, die alle Abschnitte im Dokument darstellt.
ShadeFormData { get; set; }Gibt an, ob die Grauschattierung auf Formularfeldern aktiviert werden soll.
ShowGrammaticalErrors { get; set; }Gibt an, ob Grammatikfehler in diesem Dokument angezeigt werden sollen.
ShowSpellingErrors { get; set; }Gibt an, ob Rechtschreibfehler in diesem Dokument angezeigt werden sollen.
SpellingChecked { get; set; }Gibt zurückWAHR wenn das Dokument auf Rechtschreibung geprüft wurde.
Styles { get; }Gibt eine Sammlung von im Dokument definierten Stilen zurück.
Theme { get; }Ruft die abTheme Objekt für dieses Dokument.
TrackRevisions { get; set; }True, wenn Änderungen nachverfolgt werden, wenn dieses Dokument in Microsoft Word bearbeitet wird.
Variables { get; }Gibt die Sammlung von Variablen zurück, die einem Dokument oder einer Vorlage hinzugefügt wurden.
VbaProject { get; set; }Ruft a ab oder legt es festVbaProject .
VersionsCount { get; }Ruft die Anzahl der Dokumentversionen ab, die im DOC-Dokument gespeichert wurden.
ViewOptions { get; }Bietet Optionen zur Steuerung der Anzeige des Dokuments in Microsoft Word.
WarningCallback { get; set; }Wird während verschiedener Dokumentverarbeitungsvorgänge aufgerufen, wenn ein Problem erkannt wird, das zu einem Verlust der Daten- oder Formatierungstreue führen könnte.
Watermark { get; }Bietet Zugriff auf das Dokumentwasserzeichen.
WebExtensionTaskPanes { get; }Gibt eine Sammlung zurück, die eine Liste von Aufgabenbereich-Add-Ins darstellt.
WriteProtection { get; }Bietet Zugriff auf die Schreibschutzoptionen für Dokumente.

Methoden

NameBeschreibung
override Accept(DocumentVisitor)Akzeptiert einen Besucher.
AcceptAllRevisions()Akzeptiert alle nachverfolgten Änderungen im Dokument.
AppendChild(Node)Fügt den angegebenen Knoten am Ende der Liste der untergeordneten Knoten für diesen Knoten hinzu.
AppendDocument(Document, ImportFormatMode)Hängt das angegebene Dokument an das Ende dieses Dokuments an.
AppendDocument(Document, ImportFormatModeImportFormatOptions)Hängt das angegebene Dokument an das Ende dieses Dokuments an.
Cleanup()Bereinigt nicht verwendete Stile und Listen aus dem Dokument.
Cleanup(CleanupOptions)Bereinigt je nach Angabe nicht verwendete Stile und Listen aus dem DokumentCleanupOptions .
Clone()Führt eine tiefe Kopie des ausDocument .
Clone(bool)Erstellt ein Duplikat des Knotens.
Compare(Document, string, DateTime)Vergleicht dieses Dokument mit einem anderen Dokument und erzeugt Änderungen als Anzahl der Bearbeitungs- und FormatrevisionenRevision .
Compare(Document, string, DateTime, CompareOptions)Vergleicht dieses Dokument mit einem anderen Dokument und führt zu Änderungen in Form einer Reihe von Bearbeitungs- und FormatrevisionenRevision . Ermöglicht die Angabe von Vergleichsoptionen mitCompareOptions .
CopyStylesFromTemplate(Document)Kopiert Stile aus der angegebenen Vorlage in ein Dokument.
CopyStylesFromTemplate(string)Kopiert Stile aus der angegebenen Vorlage in ein Dokument.
CreateNavigator()Erstellt einen Navigator, der zum Durchlaufen und Lesen von Knoten verwendet werden kann.
EnsureMinimum()Wenn das Dokument keine Abschnitte enthält, wird ein Abschnitt mit einem Absatz erstellt.
ExpandTableStylesToDirectFormatting()Konvertiert die in Tabellenstilen angegebene Formatierung in direkte Formatierung für Tabellen im Dokument.
ExtractPages(int, int)Gibt die zurückDocument Objekt, das den angegebenen Seitenbereich darstellt.
GetAncestor(NodeType)Ruft den ersten Vorfahren des angegebenen abNodeType .
GetAncestor(Type)Ruft den ersten Vorfahren des angegebenen Objekttyps ab.
GetChild(NodeType, int, bool)Gibt einen N-ten untergeordneten Knoten zurück, der dem angegebenen Typ entspricht.
GetChildNodes(NodeType, bool)Gibt eine Live-Sammlung untergeordneter Knoten zurück, die dem angegebenen Typ entsprechen.
GetEnumerator()Bietet Unterstützung für die Iteration jedes Stils über die untergeordneten Knoten dieses Knotens.
GetPageInfo(int)Ruft die Seitengröße, Ausrichtung und andere Informationen zu einer Seite ab, die zum Drucken oder Rendern nützlich sein könnten.
override GetText()Ruft den Text dieses Knotens und aller seiner untergeordneten Knoten ab.
ImportNode(Node, bool)Importiert einen Knoten aus einem anderen Dokument in das aktuelle Dokument.
ImportNode(Node, bool, ImportFormatMode)Importiert einen Knoten aus einem anderen Dokument in das aktuelle Dokument mit einer Option zur Steuerung der Formatierung.
IndexOf(Node)Gibt den Index des angegebenen untergeordneten Knotens im untergeordneten Knoten-Array zurück.
InsertAfter(NodeNode)Fügt den angegebenen Knoten unmittelbar nach dem angegebenen Referenzknoten ein.
InsertBefore(NodeNode)Fügt den angegebenen Knoten unmittelbar vor dem angegebenen Referenzknoten ein.
JoinRunsWithSameFormatting()Joins werden in allen Absätzen des Dokuments mit der gleichen Formatierung ausgeführt.
NextPreOrder(Node)Ruft den nächsten Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
NormalizeFieldTypes()Ändert FeldtypwerteFieldType vonFieldStart ,FieldSeparator ,FieldEnd im gesamten Dokument, sodass sie den in den Feldcodes enthaltenen Feldtypen entsprechen.
PrependChild(Node)Fügt den angegebenen Knoten am Anfang der Liste der untergeordneten Knoten für diesen Knoten hinzu.
PreviousPreOrder(Node)Ruft den vorherigen Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
Print()Druckt das gesamte Dokument auf dem Standarddrucker.
Print(PrinterSettings)Druckt das Dokument gemäß den angegebenen Druckereinstellungen, unter Verwendung des Standard-Druckcontrollers (keine Benutzeroberfläche).
Print(string)Drucken Sie das gesamte Dokument auf dem angegebenen Drucker. Verwenden Sie den Standard-Druckcontroller (keine Benutzeroberfläche).
Print(PrinterSettings, string)Druckt das Dokument gemäß den angegebenen Druckereinstellungen, unter Verwendung des Standard-Druckcontrollers (keine Benutzeroberfläche) und eines Dokumentnamens.
Protect(ProtectionType)Schützt das Dokument vor Änderungen, ohne das bestehende Passwort zu ändern oder weist ein zufälliges Passwort zu.
Protect(ProtectionType, string)Schützt das Dokument vor Änderungen und legt optional ein Schutzpasswort fest.
Remove()Entfernt sich selbst vom übergeordneten Element.
RemoveAllChildren()Entfernt alle untergeordneten Knoten des aktuellen Knotens.
RemoveChild(Node)Entfernt den angegebenen untergeordneten Knoten.
RemoveExternalSchemaReferences()Entfernt externe XML-Schema-Referenzen aus diesem Dokument.
RemoveMacros()Entfernt alle Makros (das VBA-Projekt) sowie Symbolleisten und Befehlsanpassungen aus dem Dokument.
RemoveSmartTags()Entfernt alleSmartTagNachkommenknoten des aktuellen Knotens.
RenderToScale(int, Graphics, float, float, float)Rendert eine Dokumentseite in eineGraphics Objekt in einem bestimmten Maßstab.
RenderToSize(int, Graphics, float, float, float, float)Rendert eine Dokumentseite in eineGraphics Objekt auf eine angegebene Größe.
Save(string)Speichert das Dokument in einer Datei. Ermittelt automatisch das Speicherformat anhand der Erweiterung.
Save(Stream, SaveFormat)Speichert das Dokument im angegebenen Format in einem Stream.
Save(Stream, SaveOptions)Speichert das Dokument mit den angegebenen Speicheroptionen in einem Stream.
Save(string, SaveFormat)Speichert das Dokument in einer Datei im angegebenen Format.
Save(string, SaveOptions)Speichert das Dokument mit den angegebenen Speicheroptionen in einer Datei.
Save(HttpResponse, string, ContentDispositionSaveOptions)Sendet das Dokument an den Client-Browser.
SelectNodes(string)Wählt eine Liste von Knoten aus, die dem XPath-Ausdruck entsprechen.
SelectSingleNode(string)Wählt den ersten ausNode das entspricht dem XPath-Ausdruck.
StartTrackRevisions(string)Beginnt automatisch mit der Markierung aller weiteren Änderungen, die Sie programmgesteuert am Dokument vornehmen, als Revisionsänderungen.
StartTrackRevisions(string, DateTime)Beginnt automatisch mit der Markierung aller weiteren Änderungen, die Sie programmgesteuert am Dokument vornehmen, als Revisionsänderungen.
StopTrackRevisions()Stoppt die automatische Markierung von Dokumentänderungen als Revisionen.
ToString(SaveFormat)Exportiert den Inhalt des Knotens in einen String im angegebenen Format.
ToString(SaveOptions)Exportiert den Inhalt des Knotens mit den angegebenen Speicheroptionen in einen String.
UnlinkFields()Hebt die Verknüpfung von Feldern im gesamten Dokument auf.
Unprotect()Entfernt den Schutz vom Dokument unabhängig vom Passwort.
Unprotect(string)Entfernt den Schutz vom Dokument, wenn ein korrektes Passwort angegeben wird.
UpdateFields()Aktualisiert die Werte von Feldern im gesamten Dokument.
UpdateListLabels()Aktualisiert Listenbezeichnungen für alle Listenelemente im Dokument.
UpdatePageLayout()Erstellt das Seitenlayout des Dokuments neu.
UpdateThumbnail()UpdatesThumbnail des Dokuments mit Standardoptionen.
UpdateThumbnail(ThumbnailGeneratingOptions)UpdatesThumbnail des Dokuments gemäß den angegebenen Optionen.
UpdateWordCount()Aktualisiert die Wortanzahleigenschaften des Dokuments.
UpdateWordCount(bool)Aktualisiert die Wortanzahleigenschaften des Dokuments, optional aktualisiertLines Eigenschaft.

Bemerkungen

DerDocument ist ein zentrales Objekt in der Aspose.Words-Bibliothek.

Um ein vorhandenes Dokument in eines der zu ladenLoadFormat Formate, übergeben Sie einen Dateinamen oder einen Stream an eines derDocumentKonstrukteure. Um ein leeres Dokument zu erstellen, rufen Sie den Konstruktor ohne Parameter auf.

Verwenden Sie eine der Save-Methodenüberladungen, um das Dokument in einem der zu speichern.SaveFormat Formate.

Um Dokumentseiten direkt auf ein zu zeichnenGrafik Objekt use RenderToScale oderRenderToSize Methode.

Um das Dokument zu drucken, verwenden Sie eines derPrint Methoden.

MailMerge ist die Berichts-Engine von Aspose.Words, die es ermöglicht, in Microsoft Word erstellte Berichte schnell und einfach mit Daten aus verschiedenen Datenquellen zu füllen. Die Daten können aus einem DataSet, DataTable, DataView, IDataReader oder einem Array von Werten stammen. MailMerge durchsucht die in der Datenquelle gefundenen Datensätze und fügt sie bei Bedarf in die Serienbrieffelder des Dokuments ein.

Document speichert dokumentenweite Informationen wie zStyles , BuiltInDocumentProperties ,CustomDocumentProperties Listen und Makros. Auf die meisten dieser Objekte kann über die entsprechenden Eigenschaften der zugegriffen werdenDocument.

DerDocument ist ein Wurzelknoten eines Baums, der alle anderen Knoten des Dokuments enthält. Der Baum ist ein zusammengesetztes Entwurfsmuster und ähnelt in vielerlei Hinsicht XmlDocument. Der Inhalt des Dokuments kann programmgesteuert frei manipuliert werden:

  • Auf die Knoten des Dokuments kann beispielsweise über typisierte Sammlungen zugegriffen werdenSections , ParagraphCollection usw.
  • Die Knoten des Dokuments können anhand ihres Knotentyps mit ausgewählt werden.GetChildNodes oder mithilfe einer XPath-Abfrage mitSelectNodes oderSelectSingleNode.
  • Inhaltsknoten können mit von überall im Dokument hinzugefügt oder entfernt werden.InsertBefore ,InsertAfter , RemoveChild und other -Methoden, die von der Basisklasse bereitgestellt werdenCompositeNode.
  • Die Formatierungsattribute jedes Knotens können über die Eigenschaften dieses Knotens geändert werden.

Erwägen Sie die VerwendungDocumentBuilderDies vereinfacht die Aufgabe, programmgesteuert zu erstellen oder den Dokumentbaum zu füllen.

DerDocument kann nur enthaltenSection Objekte.

In Microsoft Word muss ein gültiges Dokument mindestens einen Abschnitt haben.

Beispiele

Zeigt, wie ein Serienbrief mit Daten aus einer DataTable ausgeführt wird.

public void ExecuteDataTable()
{
    DataTable table = new DataTable("Test");
    table.Columns.Add("CustomerName");
    table.Columns.Add("Address");
    table.Rows.Add(new object[] { "Thomas Hardy", "120 Hanover Sq., London" });
    table.Rows.Add(new object[] { "Paolo Accorti", "Via Monte Bianco 34, Torino" });

    // Nachfolgend finden Sie zwei Möglichkeiten, eine DataTable als Datenquelle für einen Serienbrief zu verwenden.
    // 1 – Verwenden Sie die gesamte Tabelle für den Serienbrief, um für jede Zeile in der Tabelle ein Ausgabe-Serienbriefdokument zu erstellen:
    Document doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.WholeTable.docx");

    // 2 – Verwenden Sie eine Zeile der Tabelle, um ein Ausgabe-Serienbriefdokument zu erstellen:
    doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table.Rows[1]);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.OneRow.docx");
}

/// <summary>
/// Erstellt ein Serienbrief-Quelldokument.
/// </summary>
private static Document CreateSourceDocExecuteDataTable()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    builder.InsertField(" MERGEFIELD CustomerName ");
    builder.InsertParagraph();
    builder.InsertField(" MERGEFIELD Address ");

    return doc;
}

Siehe auch