Comment

Comment class

Stellt einen Container für den Text eines Kommentars dar.

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

public sealed class Comment : InlineStory

Konstrukteure

NameBeschreibung
Comment(DocumentBase)Initialisiert eine neue Instanz desComment Klasse.
Comment(DocumentBase, string, string, DateTime)Initialisiert eine neue Instanz desComment Klasse.

Eigenschaften

NameBeschreibung
Ancestor { get; }Gibt das übergeordnete Element zurückCommentObjekt. Gibt zurücknull für Kommentare der obersten Ebene.
Author { get; set; }Gibt den Autorennamen für einen Kommentar zurück oder legt ihn fest.
Count { get; }Ruft die Anzahl der unmittelbar untergeordneten Elemente dieses Knotens ab.
CustomNodeId { get; set; }Gibt die benutzerdefinierte Knotenkennung an.
DateTime { get; set; }Ruft das Datum und die Uhrzeit ab, zu der der Kommentar erstellt wurde.
DateTimeUtc { get; }Ruft das UTC-Datum und die UTC-Uhrzeit ab, zu der der Kommentar erstellt wurde.
virtual Document { get; }Ruft das Dokument ab, zu dem dieser Knoten gehört.
Done { get; set; }Ruft ein Flag ab oder legt es fest, das angibt, dass der Kommentar als erledigt markiert wurde.
FirstChild { get; }Ruft das erste untergeordnete Element des Knotens ab.
FirstParagraph { get; }Ruft den ersten Absatz der Geschichte ab.
Font { get; }Bietet Zugriff auf die Schriftformatierung des Ankerzeichens dieses Objekts.
HasChildNodes { get; }RückgabenWAHR wenn dieser Knoten untergeordnete Knoten hat.
Id { get; set; }Ruft die Kommentarkennung ab oder legt sie fest.
Initial { get; set; }Gibt die Initialen des Benutzers zurück, der mit einem bestimmten Kommentar verknüpft ist, oder legt sie fest.
override IsComposite { get; }RückgabenWAHR da dieser Knoten untergeordnete Knoten haben kann.
IsDeleteRevision { get; }Gibt „true“ zurück, wenn dieses Objekt in Microsoft Word gelöscht wurde, während die Änderungsverfolgung aktiviert war.
IsInsertRevision { get; }Gibt „true“ zurück, wenn dieses Objekt in Microsoft Word eingefügt wurde, während die Änderungsverfolgung aktiviert war.
IsMoveFromRevision { get; }RückgabenWAHR wenn dieses Objekt in Microsoft Word verschoben (gelöscht) wurde, während die Änderungsverfolgung aktiviert war.
IsMoveToRevision { get; }RückgabenWAHR wenn dieses Objekt in Microsoft Word verschoben (eingefügt) wurde, während die Änderungsverfolgung aktiviert war.
LastChild { get; }Ruft das letzte untergeordnete Element des Knotens ab.
LastParagraph { get; }Ruft den letzten Absatz der Geschichte ab.
NextSibling { get; }Ruft den Knoten ab, der diesem Knoten unmittelbar folgt.
override NodeType { get; }RückgabenComment .
Paragraphs { get; }Ruft eine Sammlung von Absätzen ab, die unmittelbare untergeordnete Elemente der Story sind.
ParentId { get; set; }Ruft die übergeordnete Kommentar-ID ab oder legt sie fest. Ein Wert von-1 bedeutet, dass der Kommentar keinen übergeordneten Kommentar hat.
ParentNode { get; }Ruft den unmittelbar übergeordneten Knoten dieses Knotens ab.
ParentParagraph { get; }Ruft das übergeordnete Element abParagraph dieses Knotens.
PreviousSibling { get; }Ruft den Knoten ab, der diesem Knoten unmittelbar vorausgeht.
Range { get; }Gibt einenRangeObjekt, das den Teil eines Dokuments darstellt, der in diesem Knoten enthalten ist.
Replies { get; }Gibt eine Sammlung vonComment Objekte, die unmittelbare untergeordnete Objekte des angegebenen Kommentars sind.
override StoryType { get; }RückgabenComments .
Tables { get; }Ruft eine Sammlung von Tabellen ab, die unmittelbare untergeordnete Elemente der Story sind.

Methoden

NameBeschreibung
override Accept(DocumentVisitor)Nimmt einen Besucher auf.
override AcceptEnd(DocumentVisitor)Akzeptiert einen Besucher für den Besuch des Kommentarendes.
override AcceptStart(DocumentVisitor)Akzeptiert einen Besucher für den Besuch des Kommentaranfangs.
AddReply(string, string, DateTime, string)Fügt eine Antwort auf diesen Kommentar hinzu.
AppendChild<T>(T)Fügt den angegebenen Knoten am Ende der Liste der untergeordneten Knoten für diesen Knoten hinzu.
Clone(bool)Erstellt ein Duplikat des Knotens.
CreateNavigator()Erstellt einen Navigator, der zum Durchlaufen und Lesen von Knoten verwendet werden kann.
EnsureMinimum()Wenn das letzte untergeordnete Element kein Absatz ist, wird ein leerer Absatz erstellt und angehängt.
GetAncestor(NodeType)Ruft den ersten Vorfahren des angegebenenNodeType .
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.
override GetText()Ruft den Text dieses Knotens und aller seiner untergeordneten Knoten ab.
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.
NextPreOrder(Node)Ruft den nächsten Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
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.
Remove()Entfernt sich selbst vom übergeordneten Element.
RemoveAllChildren()Entfernt alle untergeordneten Knoten des aktuellen Knotens.
RemoveAllReplies()Entfernt alle Antworten auf diesen Kommentar.
RemoveChild<T>(T)Entfernt den angegebenen untergeordneten Knoten.
RemoveReply(Comment)Entfernt die angegebene Antwort auf diesen Kommentar.
RemoveSmartTags()Entfernt alleSmartTag Nachkommenknoten des aktuellen Knotens.
SelectNodes(string)Wählt eine Liste von Knoten aus, die dem XPath-Ausdruck entsprechen.
SelectSingleNode(string)Wählt den erstenNode das dem XPath-Ausdruck entspricht.
SetText(string)Dies ist eine praktische Methode, mit der sich der Kommentartext einfach festlegen lässt.
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.

Bemerkungen

Ein Kommentar ist eine Anmerkung, die an einem Textbereich oder einer Textposition verankert ist. Ein Kommentar kann eine beliebige Menge an Inhalten auf Blockebene enthalten.

Wenn einComment Objekt tritt allein auf, der Kommentar ist verankert an der Position desComment Objekt.

Um einen Kommentar in einem Textbereich zu verankern, sind drei Objekte erforderlich:Comment , CommentRangeStart UndCommentRangeEnd . Alle drei Objekte müssen die gleiche Id Wert.

Comment ist ein Inline-Level-Knoten und kann nur ein Kind vonParagraph.

Comment kann enthaltenParagraph UndTable untergeordnete Knoten.

Beispiele

Zeigt, wie man einem Absatz einen Kommentar hinzufügt.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Write("Hello world!");

Comment comment = new Comment(doc, "John Doe", "JD", DateTime.Today);
builder.CurrentParagraph.AppendChild(comment);
builder.MoveTo(comment.AppendChild(new Paragraph(doc)));
builder.Write("Comment text.");

Assert.AreEqual(DateTime.Today, comment.DateTime);

    // In Microsoft Word können wir mit der rechten Maustaste auf diesen Kommentar im Dokumenttext klicken, um ihn zu bearbeiten oder darauf zu antworten.
doc.Save(ArtifactsDir + "InlineStory.AddComment.docx");

Zeigt, wie Sie einem Dokument einen Kommentar hinzufügen und dann darauf antworten.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Comment comment = new Comment(doc, "John Doe", "J.D.", DateTime.Now);
comment.SetText("My comment.");

// Platzieren Sie den Kommentar an einem Knoten im Hauptteil des Dokuments.
// Dieser Kommentar wird an der Stelle seines Absatzes angezeigt,
// außerhalb des rechten Seitenrands und mit einer gepunkteten Linie, die es mit dem Absatz verbindet.
builder.CurrentParagraph.AppendChild(comment);

// Fügen Sie eine Antwort hinzu, die unter dem übergeordneten Kommentar angezeigt wird.
comment.AddReply("Joe Bloggs", "J.B.", DateTime.Now, "New reply");

// Kommentare und Antworten sind beides Kommentarknoten.
Assert.AreEqual(2, doc.GetChildNodes(NodeType.Comment, true).Count);

// Kommentare, die nicht auf andere Kommentare antworten, sind „Top-Level“. Sie haben keine übergeordneten Kommentare.
Assert.Null(comment.Ancestor);

// Antworten haben einen übergeordneten Kommentar auf oberster Ebene.
Assert.AreEqual(comment, comment.Replies[0].Ancestor);

doc.Save(ArtifactsDir + "Comment.AddCommentWithReply.docx");

Siehe auch

ComHelper Class CommentCollection Class