Document

Document class

Stellt ein Word-Dokument dar.

public class Document : DocumentBase

Konstrukteure

Name Beschreibung
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

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 setzt es, das angibt, ob die Stile im Dokument jedes Mal aktualisiert werden, damit sie mit den Stilen in der angehängten -Vorlage übereinstimmen, wenn das Dokument in MS Word geöffnet wird.
BackgroundShape { get; set; } Ruft die Hintergrundform des Dokuments ab oder legt sie fest. Kann null sein.
BuiltInDocumentProperties { get; } Gibt eine Sammlung zurück, die alle integrierten Dokumenteigenschaften des Dokuments darstellt.
ChildNodes { get; } Ruft alle unmittelbar untergeordneten Knoten dieses Knotens ab.
CompatibilityOptions { get; } Bietet Zugriff auf Dokumentkompatibilitätsoptionen (d. h. die Benutzereinstellungen, die auf der Kompatibilität Registerkarte der Optionen Dialog in Word).
Compliance { get; } Ruft die aus dem geladenen Dokumentinhalt ermittelte OOXML-Konformitätsversion ab. 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 sie fest.
DefaultTabStop { get; set; } Ruft das Intervall (in Punkten) zwischen den Standardtabstopps ab oder legt es fest.
DigitalSignatures { get; } Ruft die Sammlung digitaler Signaturen für dieses Dokument und ihre Validierungsergebnisse ab.
override Document { get; }
EndnoteOptions { get; } Stellt Optionen bereit, die die Nummerierung und Positionierung von Endnoten in diesem Dokument steuern.
FieldOptions { get; } erhält a FeldoptionenObjekt, 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 Eigenschaften von Schriftarten, die in diesem Dokument verwendet werden.
FontSettings { get; set; } Ruft Schrifteinstellungen für Dokumente ab oder legt sie fest.
FootnoteOptions { get; } Bietet Optionen zur Steuerung der Nummerierung und Positionierung von Fußnoten in diesem Dokument.
Frameset { get; } Gibt a zurückFramesetInstanz, 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 AutoText-, AutoKorrektur- und Bausteineinträge, die in einem Dokument definiert sind.
GrammarChecked { get; set; } gibt zurück Stimmt wenn das Dokument auf Grammatik geprüft wurde.
HasChildNodes { get; } Gibt wahr zurück, wenn dieser Knoten untergeordnete Knoten hat.
HasMacros { get; } gibt zurück Stimmt wenn das Dokument ein VBA-Projekt (Makros) hat.
HasRevisions { get; } gibt zurück Stimmt ob das Dokument nachverfolgte Änderungen aufweist.
HyphenationOptions { get; } Bietet Zugriff auf Silbentrennungsoptionen für Dokumente.
override IsComposite { get; } Gibt wahr zurück, da dieser Knoten untergeordnete Knoten haben kann.
LastChild { get; } Ruft das letzte untergeordnete Element des Knotens ab.
LastSection { get; } Ruft den letzten Abschnitt im Dokument ab.
LayoutOptions { get; } erhält a LayoutOptionen 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ück Seriendruck Objekt, das die Seriendruckfunktion 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 entfernt wird.
override NodeType { get; } gibt zurück Knotentyp.Dokument .
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; } Holt oder setzt die Seitenfarbe des Dokuments. Diese Eigenschaft ist eine einfachere Version vonBackgroundShape .
PageCount { get; } Ruft die Anzahl der Seiten im Dokument ab, wie durch die letzte Seitenlayoutoperation berechnet.
ParentNode { get; } Ruft den unmittelbar übergeordneten Knoten dieses Knotens ab.
PreviousSibling { get; } Ruft den Knoten unmittelbar vor diesem Knoten ab.
ProtectionType { get; } Ruft den aktuell aktiven Dokumentenschutztyp ab.
Range { get; } Gibt a zurück Bereich Objekt, das den Teil eines Dokuments darstellt, das 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 (verfolgten Ä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 ursprünglichen 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 von 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ück Stimmt wenn das Dokument auf Rechtschreibung geprüft wurde.
Styles { get; } Gibt eine Sammlung von Stilen zurück, die im Dokument definiert sind.
Theme { get; } Ruft die abTheme Objekt für dieses Dokument.
TrackRevisions { get; set; } WAHR 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; } Holt oder setzt aVbaProject .
VersionsCount { get; } Ruft die Anzahl der Dokumentversionen ab, die im DOC-Dokument gespeichert wurde.
ViewOptions { get; } Bietet Optionen zum Steuern 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 der Formatierung führen kann.
Watermark { get; } Bietet Zugriff auf das Wasserzeichen des Dokuments.
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

Name Beschreibung
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, ImportFormatMode, ImportFormatOptions) Hängt das angegebene Dokument an das Ende dieses Dokuments an.
Cleanup() Entfernt ungenutzte Stile und Listen aus dem Dokument.
Cleanup(CleanupOptions) Entfernt ungenutzte Stile und Listen je nach Vorgabe aus dem DokumentCleanupOptions .
Clone() Führt eine tiefe Kopie derDocument .
Clone(bool) Erstellt ein Duplikat des Knotens.
Compare(Document, string, DateTime) Vergleicht dieses Dokument mit einem anderen Dokument, das Änderungen als Anzahl der Bearbeitungs- und Formatrevisionen erzeugtRevision .
Compare(Document, string, DateTime, CompareOptions) Vergleicht dieses Dokument mit einem anderen Dokument, das Änderungen als eine Reihe von Bearbeitungs- und Formatrevisionen hervorbringtRevision . 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() Reserviert für Systemnutzung. IXPfadNavigierbar.
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 für Tabellen im Dokument um.
ExtractPages(int, int) Gibt die zurückDocument Objekt, das einen bestimmten Seitenbereich darstellt.
GetAncestor(NodeType) Ruft den ersten Vorfahren der 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 von untergeordneten Knoten zurück, die dem angegebenen Typ entsprechen.
GetEnumerator() Bietet Unterstützung für die Iteration für jeden Stil ü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 Kinder 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 Knotenarray zurück.
InsertAfter(Node, Node) Fügt den angegebenen Knoten unmittelbar nach dem angegebenen Referenzknoten ein.
InsertBefore(Node, Node) Fügt den angegebenen Knoten unmittelbar vor dem angegebenen Referenzknoten ein.
JoinRunsWithSameFormatting() Verbindet Läufe mit derselben Formatierung in allen Absätzen des Dokuments.
NextPreOrder(Node) Ruft den nächsten Knoten gemäß dem Traversalalgorithmus des Vorbestellungsbaums ab.
NormalizeFieldTypes() Ändert FeldtypwerteFieldType vonFieldStart ,FieldSeparator ,FieldEnd im gesamten Dokument, damit 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 Traversalalgorithmus des Vorbestellungsbaums 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 gemäß den angegebenen Druckereinstellungen, unter Verwendung des Standarddruckcontrollers (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 setzt optional ein Schutzkennwort.
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-Schemareferenzen aus diesem Dokument.
RemoveMacros() Entfernt alle Makros (das VBA-Projekt) sowie Symbolleisten und Befehlsanpassungen aus dem Dokument.
RemoveSmartTags() Entfernt alleSmartTag Nachkommenknoten des aktuellen Knotens.
RenderToScale(int, Graphics, float, float, float) Rendert eine Dokumentseite in aGraphics Objekt in einem bestimmten Maßstab.
RenderToSize(int, Graphics, float, float, float, float) Rendert eine Dokumentseite in aGraphics Objekt auf eine bestimmte Größe.
Save(string) Speichert das Dokument in einer Datei. Ermittelt automatisch das Speicherformat aus der Erweiterung.
Save(Stream, SaveFormat) Speichert das Dokument unter Verwendung des angegebenen Formats 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 unter Verwendung der 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 mit dem XPath-Ausdruck übereinstimmen.
SelectSingleNode(string) Wählt den ersten Knoten aus, der mit dem XPath-Ausdruck übereinstimmt.
StartTrackRevisions(string) Beginnt automatisch damit, alle weiteren Änderungen, die Sie programmgesteuert am Dokument vornehmen, als Revisionsänderungen zu markieren.
StartTrackRevisions(string, DateTime) Beginnt automatisch damit, alle weiteren Änderungen, die Sie programmgesteuert am Dokument vornehmen, als Revisionsänderungen zu markieren.
StopTrackRevisions() Stoppt das automatische Markieren 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 unter Verwendung der angegebenen Speicheroptionen in einen String.
UnlinkFields() Hebt die Verknüpfung von Feldern im gesamten Dokument auf.
Unprotect() Entfernt den Schutz des Dokuments unabhängig vom Passwort.
Unprotect(string) Entfernt den Schutz des Dokuments, 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() Baut das Seitenlayout des Dokuments neu auf.
UpdateThumbnail() AktualisierungenThumbnail des Dokuments mit Standardoptionen.
UpdateThumbnail(ThumbnailGeneratingOptions) AktualisierungenThumbnail des Dokuments gemäß den angegebenen Optionen.
UpdateWordCount() Aktualisiert die Eigenschaften der Wortanzahl des Dokuments.
UpdateWordCount(bool) Aktualisiert die Wortzähleigenschaften des Dokuments, optional aktualisiertLines Eigentum.

Bemerkungen

Das Dokumentieren ist ein zentrales Objekt in der Aspose.Words-Bibliothek.

Um ein vorhandenes Dokument in eines der zu ladenLoadFormat übergeben Sie einen Dateinamen oder einen Stream an eines der Formate Dokumentieren Konstrukteure. 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 eine zu zeichnen Grafik Objekt verwenden RenderToScale oderRenderToSize Methode.

Verwenden Sie zum Drucken des Dokuments eines derPrintMethoden.

MailMerge ist die Berichts-Engine von Aspose.Words, die es ermöglicht, Berichte, die in Microsoft Word entworfen wurden, schnell und einfach mit Daten aus verschiedenen Datenquellen zu füllen. Die Daten können aus einem DataSet, einer DataTable, einer DataView, einem IDataReader oder einem Array von Werten stammen. Seriendruck wird die in der Datenquelle gefundenen Datensätze durchgehen und sie in Serienbrieffelder im Dokument einfügen, um es nach Bedarf zu vergrößern.

Dokumentieren speichert dokumentweite Informationen wie zStyles , BuiltInDocumentProperties ,CustomDocumentProperties , Listen und Makros. Auf die meisten dieser Objekte kann über die entsprechenden Eigenschaften der zugegriffen werden Dokumentieren.

Das Dokumentierenist ein Wurzelknoten eines Baums, der alle anderen Knoten des Dokuments enthält. Der Baum ist ein zusammengesetztes Entwurfsmuster und in vielerlei Hinsicht ähnlich wie 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 über eine XPath-Abfrage mitSelectNodes oderSelectSingleNode.
  • Inhaltsknoten können überall im Dokument mit hinzugefügt oder entfernt werden.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 das vereinfacht die Aufgabe, programmgesteuert zu erstellen oder den Dokumentbaum zu füllen.

Das Dokumentieren kann nur enthaltenSection Objekte.

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

Beispiele

Zeigt, wie ein Seriendruck 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" });

    // Im Folgenden finden Sie zwei Möglichkeiten, eine DataTable als Datenquelle für einen Seriendruck zu verwenden.
    // 1 - Verwenden Sie die gesamte Tabelle für den Seriendruck, um ein Ausgabe-Seriendruckdokument für jede Zeile in der Tabelle 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 Seriendruckdokument zu erstellen:
    doc = CreateSourceDocExecuteDataTable();

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

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

/// <summary>
/// Erstellt ein Seriendruck-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