Comment

Comment class

表示评论文本的容器。

要了解更多信息，请访问使用评论文档文章。

public sealed class Comment : InlineStory

构造函数

姓名描述
Comment(DocumentBase)初始化Comment类.
Comment(DocumentBase, string, string, DateTime)初始化Comment类.

特性

姓名描述
Ancestor { get; }返回父级Comment对象。返回无效的用于顶级评论。
Author { get; set; }返回或设置评论的作者姓名。
Count { get; }获取此节点的直属子节点的数量。
CustomNodeId { get; set; }指定自定义节点标识符。
DateTime { get; set; }获取发表评论的日期和时间。
DateTimeUtc { get; }获取发表评论的 UTC 日期和时间。
virtual Document { get; }获取此节点所属的文档。
Done { get; set; }获取或设置标志，指示评论已被标记为完成。
FirstChild { get; }获取节点的第一个子节点。
FirstParagraph { get; }获取故事的第一段。
Font { get; }提供对此对象的锚字符的字体格式的访问。
HasChildNodes { get; }返回真的如果此节点有任何子节点。
Id { get; set; }获取或设置注释标识符。
Initial { get; set; }返回或设置与特定评论相关的用户的姓名首字母。
override IsComposite { get; }返回真的因为这个节点可以有子节点。
IsDeleteRevision { get; }如果在启用更改跟踪的情况下在 Microsoft Word 中删除了此对象，则返回 true。
IsInsertRevision { get; }如果在启用更改跟踪的情况下将此对象插入 Microsoft Word，则返回 true。
IsMoveFromRevision { get; }返回真的如果在启用更改跟踪的情况下在 Microsoft Word 中移动（删除）此对象。
IsMoveToRevision { get; }返回真的如果在启用更改跟踪的情况下在 Microsoft Word 中移动（插入）此对象。
LastChild { get; }获取节点的最后一个子节点。
LastParagraph { get; }获取故事的最后一段。
NextSibling { get; }获取紧随此节点之后的节点。
override NodeType { get; }返回Comment.
Paragraphs { get; }获取故事的直接子段落集合。
ParentId { get; set; }获取或设置父评论 ID。值为-1表示该评论没有父评论。
ParentNode { get; }获取此节点的直接父节点。
ParentParagraph { get; }检索父级Paragraph此节点的。
PreviousSibling { get; }获取此节点前一个节点。
Range { get; }返回Range表示此节点中包含的文档部分的对象。
Replies { get; }返回Comment指定注释的直接子对象。
override StoryType { get; }返回Comments.
Tables { get; }获取故事的直接子表集合。

方法

姓名描述
override Accept(DocumentVisitor)接受访客。
override AcceptEnd(DocumentVisitor)接受访客访问评论末尾。
override AcceptStart(DocumentVisitor)接受访客访问评论的开头。
AddReply(string, string, DateTime, string)添加对此评论的回复。
AppendChild<T>(T)将指定节点添加到此节点的子节点列表的末尾。
Clone(bool)创建节点的副本。
CreateNavigator()创建可用于遍历和读取节点的导航器。
EnsureMinimum()如果最后一个子项不是段落，则创建并附加一个空段落。
GetAncestor(NodeType)获取指定的第一个祖先NodeType.
GetAncestor(Type)获取指定对象类型的第一个祖先。
GetChild(NodeType, int, bool)返回与指定类型匹配的第 N 个子节点。
GetChildNodes(NodeType, bool)返回与指定类型匹配的子节点的实时集合。
GetEnumerator()为该节点的子节点提供对每个样式迭代的支持。
override GetText()获取此节点及其所有子节点的文本。
IndexOf(Node)返回子节点数组中指定子节点的索引。
InsertAfter<T>(T, Node)在指定的参考节点后立即插入指定的节点。
InsertBefore<T>(T, Node)在指定的参考节点之前立即插入指定的节点。
NextPreOrder(Node)根据前序树遍历算法获取下一个节点。
PrependChild<T>(T)将指定节点添加到此节点的子节点列表的开头。
PreviousPreOrder(Node)根据前序树遍历算法获取前一个节点。
Remove()将自身从父级中移除。
RemoveAllChildren()删除当前节点的所有子节点。
RemoveAllReplies()删除对此评论的所有回复。
RemoveChild<T>(T)删除指定的子节点。
RemoveReply(Comment)删除对此评论的指定回复。
RemoveSmartTags()删除所有SmartTag当前节点的后代节点。
SelectNodes(string)选择与 XPath 表达式匹配的节点列表。
SelectSingleNode(string)选择第一个Node与 XPath 表达式匹配。
SetText(string)这是一种便捷的方法，可以轻松设置评论的文本。
ToString(SaveFormat)将节点的内容导出为指定格式的字符串。
ToString(SaveOptions)使用指定的保存选项将节点内容导出为字符串。

评论

注释是锚定在文本区域或文本中某个位置的注解。 注释可以包含任意数量的块级内容。

如果Comment对象单独出现，注释锚定到 的位置Comment目的。

要将评论锚定到文本区域，需要三个对象：Comment, CommentRangeStart和CommentRangeEnd 。所有三个对象都需要共享相同的 Id价值。

Comment是内联级节点，并且只能是Paragraph。

Comment可以包含Paragraph和Table子节点。

例子

展示如何向段落添加注释。

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

 // 在Microsoft Word中，我们可以在文档正文中右键单击该注释来编辑它，或者回复它。
doc.Save(ArtifactsDir + "InlineStory.AddComment.docx");

展示如何向文档添加评论，然后对其进行回复。

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

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

// 将注释放置在文档正文中的某个节点处。
// 此评论将显示在其段落的位置，
// 位于页面右侧边距之外，并用虚线将其与段落连接起来。
builder.CurrentParagraph.AppendChild(comment);

// 添加回复，它将显示在其父评论下。
comment.AddReply("Joe Bloggs", "J.B.", DateTime.Now, "New reply");

// 评论和回复都是评论节点。
Assert.AreEqual(2, doc.GetChildNodes(NodeType.Comment, true).Count);

// 不回复其他评论的评论是“顶级”评论。它们没有祖先评论。
Assert.Null(comment.Ancestor);

// 回复有一个祖先顶级评论。
Assert.AreEqual(comment, comment.Replies[0].Ancestor);

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

也可以看看

ComHelper Class CommentCollection Class