FieldComments

FieldComments class

实现 COMMENTS 字段。

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

public class FieldComments : Field

构造函数

姓名描述
FieldComments()默认构造函数。

特性

姓名描述
DisplayResult { get; }获取表示显示的字段结果的文本。
End { get; }获取表示字段结束的节点。
Format { get; }获得FieldFormat提供对字段格式的类型化访问的对象。
IsDirty { get; set; }获取或设置字段的当前结果是否由于对文档进行的其他修改而不再正确（陈旧）。
IsLocked { get; set; }获取或设置字段是否被锁定（不应重新计算其结果）。
LocaleId { get; set; }获取或设置字段的 LCID。
Result { get; set; }获取或设置字段分隔符和字段结束之间的文本。
Separator { get; }获取表示字段分隔符的节点。可无效的.
Start { get; }获取表示字段开始的节点。
Text { get; set; }获取或设置评论文本。
virtual Type { get; }获取 Microsoft Word 字段类型。

方法

姓名描述
GetFieldCode()返回字段开始和字段分隔符之间的文本（如果没有分隔符，则返回字段结束）。 包括子字段的字段代码和字段结果。
GetFieldCode(bool)返回字段开始和字段分隔符之间的文本（如果没有分隔符，则返回字段结束）。
Remove()从文档中删除该字段。返回字段后面的节点。如果字段的结尾是其父节点的最后一个 child ，则返回其父段落。如果该字段已被删除，则返回无效的.
Unlink()执行字段取消链接。
Update()执行字段更新。如果该字段已被更新，则抛出异常。
Update(bool)执行字段更新。如果该字段已被更新，则抛出异常。

评论

检索并可选择设置与当前文档相关的注释，如记录在Commentsproperty 内置文档属性.

例子

展示如何使用 COMMENTS 字段。

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

// 为文档的“Comments”内置属性设置一个值。
doc.BuiltInDocumentProperties.Comments = "My comment.";

// 创建一个 COMMENTS 字段来显示该内置属性的值。
FieldComments field = (FieldComments)builder.InsertField(FieldType.FieldComments, true);
field.Update();

Assert.AreEqual(" COMMENTS ", field.GetFieldCode());
Assert.AreEqual("My comment.", field.Result);

// 如果我们给出 COMMENTS 字段的 Text 属性值并更新它，该字段将
// 用 Text 属性的值覆盖“Comments”内置属性的当前值，
// 然后显示新值。
field.Text = "My overriding comment.";
field.Update();

Assert.AreEqual(" COMMENTS  \"My overriding comment.\"", field.GetFieldCode());
Assert.AreEqual("My overriding comment.", field.Result);

doc.Save(ArtifactsDir + "Field.COMMENTS.docx");

也可以看看

FieldCollection Class FieldCompare Class