Document

Document class

Stellt ein Word-Dokument dar.

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

public class Document : DocumentBase

Konstrukteure

Name	Beschreibung
Document()	Erstellt ein leeres Word-Dokument.
Document(Stream)	Öffnet ein vorhandenes Dokument aus einem Stream. Das Dateiformat wird automatisch erkannt.
Document(string)	Öffnet ein vorhandenes Dokument aus einer Datei. Das Dateiformat wird automatisch erkannt.
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

Name	Beschreibung
AttachedTemplate { get; set; }	Ruft den vollständigen Pfad der an das Dokument angehängten Vorlage ab oder legt ihn fest.
AutomaticallyUpdateStyles { get; set; }	Ruft ein Flag ab oder legt ein Flag fest, das angibt, ob die Stile im Dokument bei jedem Öffnen des Dokuments in MS Word aktualisiert werden, um mit den Stilen in der angehängten Vorlage übereinzustimmen.
BackgroundShape { get; set; }	Ruft die Hintergrundform des Dokuments ab oder legt sie fest. Kann sein`null` .
Bibliography { get; }	Ruft die`Bibliography`Objekt, das die Liste der im Dokument verfügbaren Quellen darstellt.
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 auf demKompatibilität Registerkarte desOptionenDialogfeld in Word).
Compliance { get; }	Ruft die OOXML-Konformitätsversion ab, die aus dem geladenen Dokumentinhalt ermittelt wurde. Ist nur für OOXML-Dokumente sinnvoll.
Count { get; }	Ruft die Anzahl der unmittelbar untergeordneten Elemente 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 Auflistung der benutzerdefinierten XML-Datenspeicherteile ab oder legt sie fest.
DefaultTabStop { get; set; }	Ruft das Intervall (in Punkten) zwischen den Standard-Tabstopps 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 zur Steuerung der Nummerierung und Positionierung von Endnoten in diesem Dokument.
FieldOptions { get; }	Erhält eine`FieldOptions` Objekt, das Optionen zur Steuerung der Feldbehandlung 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 die Schriftarteinstellungen des Dokuments ab oder legt sie fest.
FootnoteOptions { get; }	Bietet Optionen zur Steuerung der Nummerierung und Positionierung von Fußnoten in diesem Dokument.
FootnoteSeparators { get; }	Bietet Zugriff auf die im Dokument definierten Fußnoten-/Endnotentrennzeichen.
Frameset { get; }	Gibt einen`Frameset` Instanz, wenn dieses Dokument eine Frames-Seite darstellt.
GlossaryDocument { get; set; }	Ruft das Glossardokument innerhalb dieses Dokuments oder dieser Vorlage ab oder legt es fest. Ein Glossardokument ist ein Speicher für in einem Dokument definierte AutoText-, AutoKorrektur- und Bausteineinträge.
GrammarChecked { get; set; }	Rückgaben`WAHR` ob das Dokument auf Grammatik geprüft wurde.
HasChildNodes { get; }	Rückgaben`WAHR` wenn dieser Knoten untergeordnete Knoten hat.
HasMacros { get; }	Rückgaben`WAHR` wenn das Dokument ein VBA-Projekt (Makros) enthält.
HasRevisions { get; }	Rückgaben`WAHR` ob das Dokument nachverfolgte Änderungen enthält.
HyphenationOptions { get; }	Bietet Zugriff auf Dokument-Silbentrennungsoptionen.
IncludeTextboxesFootnotesEndnotesInStat { get; set; }	Gibt an, ob Textfelder, Fußnoten und Endnoten in die Wortzählstatistik einbezogen werden sollen.
override IsComposite { get; }	Rückgaben`WAHR` 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; }	Erhält eine`LayoutOptions` Objekt, das Optionen zur Steuerung des Layoutprozesses dieses Dokuments darstellt.
Lists { get; }	Bietet Zugriff auf die im Dokument verwendete Listenformatierung.
MailMerge { get; }	Gibt einen`MailMerge` Objekt, das die Serienbrieffunktion für das Dokument darstellt.
MailMergeSettings { get; set; }	Ruft das Objekt ab oder legt es fest, das alle Seriendruckinformationen 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 im Dokument eingefügt oder daraus entfernt wird.
override NodeType { get; }	RückgabenDocument .
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 sie fest, die über „unbekannte Beziehungen“ mit dem OOXML-Paket verknüpft sind.
PageColor { get; set; }	Ruft die Seitenfarbe des Dokuments ab oder legt sie fest. Diese Eigenschaft ist eine einfachere Version von`BackgroundShape` .
PageCount { get; }	Ruft die Anzahl der Seiten im Dokument ab, die durch den letzten Seitenlayoutvorgang berechnet wurde.
ParentNode { get; }	Ruft den unmittelbar übergeordneten Knoten dieses Knotens ab.
PreviousSibling { get; }	Ruft den Knoten ab, der diesem Knoten unmittelbar vorausgeht.
ProtectionType { get; }	Ruft den aktuell aktiven Dokumentschutztyp ab.
PunctuationKerning { get; set; }	Gibt an, ob das Kerning sowohl auf lateinischen Text als auch auf die Zeichensetzung angewendet wird.
Range { get; }	Gibt einen`Range`Objekt, das den Teil eines Dokuments darstellt, der in diesem Knoten enthalten ist.
RemovePersonalInformation { get; set; }	Ruft ein Flag ab oder legt es fest, das angibt, dass Microsoft Word beim Speichern des Dokuments alle Benutzerinformationen aus Kommentaren, Revisionen und Dokumenteigenschaften entfernt.
ResourceLoadingCallback { get; set; }	Ermöglicht die Steuerung des Ladens externer Ressourcen.
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 einen Wert 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 graue Schattierung für Formularfelder 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; }	Rückgaben`WAHR` wenn das Dokument auf Rechtschreibung geprüft wurde.
Styles { get; }	Gibt eine Sammlung der im Dokument definierten Stile zurück.
Theme { get; }	Ruft die`Theme` 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 der Variablen zurück, die einem Dokument oder einer Vorlage hinzugefügt wurden.
VbaProject { get; set; }	Ruft ab oder setzt einen`VbaProject` .
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 Dokumentverarbeitungsverfahren aufgerufen, wenn ein Problem erkannt wird, das zu einem Verlust der Daten- oder Formatierungsgenauigkeit führen kann.
Watermark { get; }	Bietet Zugriff auf das Dokumentwasserzeichen.
WebExtensionTaskPanes { get; }	Gibt eine Auflistung zurück, die eine Liste von Aufgabenbereich-Add-Ins darstellt.
WriteProtection { get; }	Bietet Zugriff auf die Schreibschutzoptionen für Dokumente.

Methoden

Name	Beschreibung
override Accept(DocumentVisitor)	Nimmt einen Besucher auf.
AcceptAllRevisions()	Akzeptiert alle nachverfolgten Änderungen im Dokument.
override AcceptEnd(DocumentVisitor)	Akzeptiert einen Besucher zum Aufrufen des Dokumentenendes.
override AcceptStart(DocumentVisitor)	Akzeptiert einen Besucher für den Besuch des Dokumentanfangs.
AppendChild<T>(T)	Fügt den angegebenen Knoten am Ende der Liste der untergeordneten Knoten für diesen Knoten hinzu.
AppendDocument(Document, ImportFormatMode)	Fügt das angegebene Dokument an das Ende dieses Dokuments an.
AppendDocument(Document, ImportFormatMode, ImportFormatOptions)	Fügt das angegebene Dokument an das Ende dieses Dokuments an.
Cleanup()	Löscht nicht verwendete Stile und Listen aus dem Dokument.
Cleanup(CleanupOptions)	Löscht nicht verwendete Stile und Listen aus dem Dokument, abhängig von der gegebenen`CleanupOptions` .
Clone()	Führt eine vollständige Kopie der`Document` .
Clone(bool)	Erstellt ein Duplikat des Knotens.
Compare(Document, string, DateTime)	Vergleicht dieses Dokument mit einem anderen Dokument und führt zu Änderungen hinsichtlich der Anzahl der Bearbeitungen und Formatänderungen.`Revision` .
Compare(Document, string, DateTime, CompareOptions)	Vergleicht dieses Dokument mit einem anderen Dokument und führt zu Änderungen in Form von Bearbeitungs- und Formatänderungen.`Revision` . Ermöglicht die Angabe von Vergleichsoptionen mit`CompareOptions` .
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()	Wandelt die in Tabellenstilen angegebene Formatierung in direkte Formatierung der Tabellen im Dokument um.
ExtractPages(int, int)	Gibt die`Document` Objekt, das den angegebenen Seitenbereich darstellt.
GetAncestor(NodeType)	Ruft den ersten Vorfahren des angegebenen`NodeType` .
GetAncestor(Type)	Ruft den ersten Vorgänger 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 von untergeordneten Knoten zurück, die dem angegebenen Typ entsprechen.
GetEnumerator()	Bietet Unterstützung für die Iteration des For-Each-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önnen.
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<T>(T, Node)	Fügt den angegebenen Knoten unmittelbar nach dem angegebenen Referenzknoten ein.
InsertBefore<T>(T, Node)	Fügt den angegebenen Knoten unmittelbar vor dem angegebenen Referenzknoten ein.
JoinRunsWithSameFormatting()	Verknüpfungen werden mit der gleichen Formatierung in allen Absätzen des Dokuments ausgeführt.
NextPreOrder(Node)	Ruft den nächsten Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
NormalizeFieldTypes()	Ändert Feldtypwerte`FieldType` von`FieldStart` ,`FieldSeparator` ,`FieldEnd` im gesamten Dokument, sodass sie den in den Feldfunktionen enthaltenen Feldtypen entsprechen.
PrependChild<T>(T)	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 Standarddruckcontrollers (ohne Benutzeroberfläche).
Print(string)	Drucken Sie das gesamte Dokument auf dem angegebenen Drucker, unter Verwendung des Standarddruckcontrollers (ohne Benutzeroberfläche).
Print(PrinterSettings, string)	Druckt das Dokument entsprechend den angegebenen Druckereinstellungen, unter Verwendung des Standard-Druckcontrollers (ohne Benutzeroberfläche) und eines Dokumentnamens.
Protect(ProtectionType)	Schützt das Dokument vor Änderungen, ohne das bestehende Passwort zu ändern oder vergibt ein zufälliges Passwort.
Protect(ProtectionType, string)	Schützt das Dokument vor Änderungen und legt optional ein Schutzkennwort fest.
Remove()	Entfernt sich selbst vom übergeordneten Element.
RemoveAllChildren()	Entfernt alle untergeordneten Knoten des aktuellen Knotens.
RemoveBlankPages()	Entfernt leere Seiten aus dem Dokument.
RemoveChild<T>(T)	Entfernt den angegebenen untergeordneten Knoten.
RemoveExternalSchemaReferences()	Entfernt externe XML-Schemareferenzen aus diesem Dokument.
RemoveMacros()	Entfernt alle Makros (das VBA-Projekt) sowie Symbolleisten und Befehlsanpassungen aus dem Dokument.
RemoveSmartTags()	Entfernt alle`SmartTag` Nachkommenknoten des aktuellen Knotens.
RenderToScale(int, Graphics, float, float, float)	Rendert eine Dokumentseite in eineGraphics Objekt auf einen 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. Das Speicherformat wird automatisch anhand der Erweiterung ermittelt.
Save(Stream, SaveFormat)	Speichert das Dokument im angegebenen Format in einem Stream.
Save(Stream, SaveOptions)	Speichert das Dokument unter Verwendung der 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, ContentDisposition, SaveOptions)	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`Node` das dem XPath-Ausdruck entspricht.
StartTrackRevisions(string)	Beginnt automatisch, alle weiteren Änderungen, die Sie programmgesteuert am Dokument vornehmen, als Revisionsänderungen zu markieren.
StartTrackRevisions(string, DateTime)	Beginnt automatisch, alle weiteren Änderungen, die Sie programmgesteuert am Dokument vornehmen, als Revisionsänderungen zu markieren.
StopTrackRevisions()	Stoppt die automatische Kennzeichnung von Dokumentänderungen als Revisionen.
ToString(SaveFormat)	Exportiert den Inhalt des Knotens in eine Zeichenfolge im angegebenen Format.
ToString(SaveOptions)	Exportiert den Inhalt des Knotens unter Verwendung der angegebenen Speicheroptionen in eine Zeichenfolge.
UnlinkFields()	Hebt die Verknüpfung von Feldern im gesamten Dokument auf.
Unprotect()	Entfernt den Schutz des Dokuments, unabhängig vom Kennwort.
Unprotect(string)	Entfernt den Schutz vom Dokument, wenn ein korrektes Kennwort angegeben ist.
UpdateActualReferenceMarks()	Aktualisiert die`ActualReferenceMark` Eigenschaft aller Fußnoten und Endnoten im Dokument.
UpdateFields()	Aktualisiert die Werte der Felder im gesamten Dokument.
UpdateListLabels()	Aktualisiert Listenbeschriftungen für alle Listenelemente im Dokument.
UpdatePageLayout()	Erstellt das Seitenlayout des Dokuments neu.
UpdateThumbnail()	Aktualisierungen`Thumbnail` des Dokuments mit Standardoptionen.
UpdateThumbnail(ThumbnailGeneratingOptions)	Aktualisierungen`Thumbnail` des Dokuments gemäß den angegebenen Optionen.
UpdateWordCount()	Aktualisiert die Wortanzahleigenschaften des Dokuments.
UpdateWordCount(bool)	Aktualisiert die Wortanzahleigenschaften des Dokuments, aktualisiert optional`Lines` Eigenschaft.

Bemerkungen

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

Um ein vorhandenes Dokument in einem derLoadFormat Formate, übergeben Sie einen Dateinamen oder einen Stream in eines derDocument Konstruktoren. 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 SaveFormat Formate.

Um Dokumentseiten direkt auf einGrafik Objekt use RenderToScale oderRenderToSize Verfahren.

Um das Dokument auszudrucken, verwenden Sie eine derPrint Methoden.

MailMergeist die Berichts-Engine von Aspose.Words, mit der sich in Microsoft Word erstellte Berichte schnell und einfach mit Daten aus verschiedenen Datenquellen füllen lassen. Die Daten können aus einem DataSet, einer DataTable, einer DataView, einem IDataReader oder einem Werte-Array stammen.Serienbrief geht die in der Datenquelle gefundenen Datensätze durch und fügt sie in Serienbrieffelder im Dokument ein und erweitert es nach Bedarf.

Document speichert dokumentenweite Informationen wieStyles , BuiltInDocumentProperties ,CustomDocumentProperties , Listen und Makros. Die meisten dieser Objekte sind über die entsprechenden Eigenschaften desDocument.

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

Auf die Knoten des Dokuments kann über typisierte Sammlungen zugegriffen werden, beispielsweiseSections , ParagraphCollection usw.
Die Knoten des Dokuments können nach ihrem Knotentyp ausgewählt werden mit GetChildNodes oder mithilfe einer XPath-Abfrage mitSelectNodes oderSelectSingleNode.
Inhaltsknoten können überall im Dokument hinzugefügt oder entfernt werden, indem InsertBefore ,InsertAfter , RemoveChild und andere -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 VerwendungDocumentBuilder Dies vereinfacht die Aufgabe, programmgesteuert x000d_ zu erstellen oder den Dokumentbaum aufzufüllen.

DerDocument kann nur enthaltenSection Objekte.

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

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 Seriendruck, um für jede Zeile in der Tabelle ein Ausgabe-Seriendruckdokument 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 Serienbrief-Ausgabedokument 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

class DocumentBase
namensraum Aspose.Words
Montage Aspose.Words

ConvertUtil Class DocumentBase Class