Comment

Comment class

Repräsentiert einen Container für den Text eines Kommentars.

public sealed class Comment : InlineStory

Konstrukteure

Name Beschreibung
Comment(DocumentBase) Initialisiert eine neue Instanz von Kommentar Klasse.
Comment(DocumentBase, string, string, DateTime) Initialisiert eine neue Instanz von Kommentar Klasse.

Eigenschaften

Name Beschreibung
Ancestor { get; } Gibt das übergeordnete Kommentarobjekt zurück. Gibt null für Kommentare der obersten Ebene zurück.
Author { get; set; } Gibt den Autorennamen für einen Kommentar zurück oder legt ihn fest.
ChildNodes { get; } Ruft alle unmittelbar untergeordneten Knoten dieses Knotens ab.
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 oder setzt Flag, das anzeigt, 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 wahr zurück, wenn dieser Knoten untergeordnete Knoten hat.
Id { get; } Ruft die Kommentarkennung 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 wahr zurück, 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 Änderungsnachverfolgung 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ück Stimmt wenn dieses Objekt in Microsoft Word verschoben (gelöscht) wurde, während die Änderungsnachverfolgung aktiviert war.
IsMoveToRevision { get; } gibt zurück Stimmt wenn dieses Objekt in Microsoft Word verschoben (eingefügt) wurde, während die Änderungsnachverfolgung aktiviert war.
LastChild { get; } Ruft das letzte untergeordnete Element des Knotens ab.
LastParagraph { get; } Ruft den letzten Absatz in der Story ab.
NextSibling { get; } Ruft den Knoten ab, der diesem Knoten unmittelbar folgt.
override NodeType { get; } gibt zurück Knotentyp.Kommentar .
Paragraphs { get; } Ruft eine Sammlung von Absätzen ab, die der Geschichte direkt untergeordnet sind.
ParentNode { get; } Ruft den unmittelbar übergeordneten Knoten dieses Knotens ab.
ParentParagraph { get; } Ruft das übergeordnete Element abParagraph dieses Knotens.
PreviousSibling { get; } Ruft den Knoten unmittelbar vor diesem Knoten ab.
Range { get; } Gibt a zurück Bereich Objekt, das den Teil eines Dokuments darstellt, das in diesem Knoten enthalten ist.
Replies { get; } Gibt eine Sammlung von zurückComment Objekte, die unmittelbar untergeordnete Elemente des angegebenen Kommentars sind.
override StoryType { get; } gibt zurück StoryType.Kommentare .
Tables { get; } Ruft eine Sammlung von Tabellen ab, die unmittelbar untergeordnete Elemente der Story sind.

Methoden

Name Beschreibung
override Accept(DocumentVisitor) Akzeptiert einen Besucher.
AddReply(string, string, DateTime, string) Fügt diesem Kommentar eine Antwort 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() Reserviert für Systemnutzung. IXPfadNavigierbar.
EnsureMinimum() Wenn das letzte untergeordnete Element kein Absatz ist, wird ein leerer Absatz erstellt und angehängt.
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.
override GetText() Ruft den Text dieses Knotens und aller seiner Kinder ab.
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.
NextPreOrder(Node) Ruft den nächsten Knoten gemäß dem Traversalalgorithmus des Vorbestellungsbaums 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 Traversalalgorithmus des Vorbestellungsbaums 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 alleSmartTag Nachkommenknoten des aktuellen Knotens.
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.
SetText(string) Dies ist eine bequeme Methode, mit der Sie den Text des Kommentars einfach festlegen können.
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.

Bemerkungen

Ein Kommentar ist eine Anmerkung, die an einem Textbereich oder an einer Stelle im Text verankert ist. Ein Kommentar kann beliebig viele Inhalte auf Blockebene enthalten.

Wenn einComment Objekt alleine auftritt, wird 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 Kind von seinParagraph.

Comment enthalten kannParagraph undTable untergeordnete Knoten.

Beispiele

Zeigt, wie Sie einem Absatz einen Kommentar hinzufügen.

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 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.");

// Platziere den Kommentar an einem Knoten im Hauptteil des Dokuments.
// Dieser Kommentar wird an der Stelle seines Absatzes angezeigt,
// außerhalb des rechten Rands der Seite und mit einer gepunkteten Linie, die ihn mit seinem Absatz verbindet.
builder.CurrentParagraph.AppendChild(comment);

// Füge eine Antwort hinzu, 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 "oberste Ebene". 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