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 vonComment Klasse.
Comment(DocumentBase, string, string, DateTime)Initialisiert eine neue Instanz vonComment Klasse.

Eigenschaften

NameBeschreibung
Ancestor { get; }Gibt das übergeordnete Element zurückComment Objekt. Kehrt 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 unmittelbaren Kinder 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.
virtual Document { get; }Ruft das Dokument ab, zu dem dieser Knoten gehört.
Done { get; set; }Ruft ein Flag ab oder setzt es, 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 in der Geschichte ab.
Font { get; }Bietet Zugriff auf die Schriftartformatierung des Ankerzeichens dieses Objekts.
HasChildNodes { get; }Gibt zurückWAHR wenn dieser Knoten untergeordnete Knoten hat.
Id { get; }Ruft die Kommentar-ID ab.
Initial { get; set; }Gibt die Initialen des Benutzers zurück, der einem bestimmten Kommentar zugeordnet ist, oder legt sie fest.
override IsComposite { get; }Gibt zurückWAHR 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; }Gibt zurückWAHR wenn dieses Objekt in Microsoft Word verschoben (gelöscht) wurde, während die Änderungsverfolgung aktiviert war.
IsMoveToRevision { get; }Gibt zurückWAHR 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 in der Geschichte ab.
NextSibling { get; }Ruft den Knoten ab, der diesem Knoten unmittelbar folgt.
override NodeType { get; }Gibt zurückComment .
Paragraphs { get; }Ruft eine Sammlung von Absätzen ab, die unmittelbar untergeordnete Elemente der Geschichte sind.
ParentNode { get; }Ruft das unmittelbare übergeordnete Element dieses Knotens ab.
ParentParagraph { get; }Ruft das übergeordnete Element abParagraph dieses Knotens.
PreviousSibling { get; }Ruft den Knoten ab, der diesem Knoten unmittelbar vorangeht.
Range { get; }Gibt a zurückRange Objekt, das den Teil eines Dokuments darstellt, der in diesem Knoten enthalten ist.
Replies { get; }Gibt eine Sammlung von zurückComment Objekte, die unmittelbare untergeordnete Elemente des angegebenen Kommentars sind.
override StoryType { get; }Gibt zurückComments .
Tables { get; }Ruft eine Sammlung von Tabellen ab, die unmittelbar untergeordnete Elemente der Story sind.

Methoden

NameBeschreibung
override Accept(DocumentVisitor)Akzeptiert einen Besucher.
AddReply(string, string, DateTime, string)Fügt eine Antwort zu diesem Kommentar hinzu.
AppendChild(Node)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 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.
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(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.
NextPreOrder(Node)Ruft den nächsten Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
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.
Remove()Entfernt sich selbst vom übergeordneten Element.
RemoveAllChildren()Entfernt alle untergeordneten Knoten des aktuellen Knotens.
RemoveAllReplies()Entfernt alle Antworten auf diesen Kommentar.
RemoveChild(Node)Entfernt den angegebenen untergeordneten Knoten.
RemoveReply(Comment)Entfernt die angegebene Antwort auf diesen Kommentar.
RemoveSmartTags()Entfernt alleSmartTagNachkommenknoten des aktuellen Knotens.
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.
SetText(string)Dies ist eine praktische Methode, die es ermöglicht, den Text des Kommentars einfach festzulegen.
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.

Bemerkungen

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

Wenn einComment Wenn das Objekt alleine auftritt, ist der Kommentar an der Position des verankertComment Objekt.

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

Comment ist ein Knoten auf Inline-Ebene und kann nur ein untergeordnetes Element von seinParagraph.

Comment enthalten kannParagraph 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 man einem Dokument einen Kommentar hinzufügt und dann darauf antwortet.

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 Randes der Seite und mit einer gepunkteten Linie, die es mit seinem Absatz verbindet.
builder.CurrentParagraph.AppendChild(comment);

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

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

// Kommentare, die nicht auf andere Kommentare antworten, sind „Top-Level“. Sie haben keine Vorfahrenkommentare.
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