VisitCommentStart
内容
[
隐藏
]DocumentVisitor.VisitCommentStart method
开始枚举注释文本时调用。
public virtual VisitorAction VisitCommentStart(Comment comment)
范围 | 类型 | 描述 |
---|---|---|
comment | Comment | 正在访问的对象。 |
返回值
AVisitorAction
指定如何继续枚举的值。
例子
展示如何打印文档中每个注释和注释范围的节点结构。
public void CommentsToText()
{
Document doc = new Document(MyDir + "DocumentVisitor-compatible features.docx");
CommentStructurePrinter visitor = new CommentStructurePrinter();
// 当我们得到一个复合节点来接受文档访问者时,访问者访问接受节点,
// 然后以深度优先的方式遍历该节点的所有子节点。
// 访问者可以读取和修改每个访问过的节点。
doc.Accept(visitor);
Console.WriteLine(visitor.GetText());
}
/// <summary>
/// 遍历节点的子节点的非二叉树。
/// 以字符串形式创建所有遇到的 Comment/CommentRange 节点及其子节点的映射。
/// </summary>
public class CommentStructurePrinter : DocumentVisitor
{
public CommentStructurePrinter()
{
mBuilder = new StringBuilder();
mVisitorIsInsideComment = false;
}
public string GetText()
{
return mBuilder.ToString();
}
/// <summary>
/// 在文档中遇到 Run 节点时调用。
/// 仅当 Run 是 Comment 或 CommentRange 节点的子节点时才会记录 Run。
/// </summary>
public override VisitorAction VisitRun(Run run)
{
if (mVisitorIsInsideComment) IndentAndAppendLine("[Run] \"" + run.GetText() + "\"");
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 CommentRangeStart 节点时调用。
/// </summary>
public override VisitorAction VisitCommentRangeStart(CommentRangeStart commentRangeStart)
{
IndentAndAppendLine("[Comment range start] ID: " + commentRangeStart.Id);
mDocTraversalDepth++;
mVisitorIsInsideComment = true;
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 CommentRangeEnd 节点时调用。
/// </summary>
public override VisitorAction VisitCommentRangeEnd(CommentRangeEnd commentRangeEnd)
{
mDocTraversalDepth--;
IndentAndAppendLine("[Comment range end]");
mVisitorIsInsideComment = false;
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 Comment 节点时调用。
/// </summary>
public override VisitorAction VisitCommentStart(Comment comment)
{
IndentAndAppendLine(
$"[Comment start] For comment range ID {comment.Id}, By {comment.Author} on {comment.DateTime}");
mDocTraversalDepth++;
mVisitorIsInsideComment = true;
return VisitorAction.Continue;
}
/// <summary>
/// Comment 节点的所有子节点都被访问后调用。
/// </summary>
public override VisitorAction VisitCommentEnd(Comment comment)
{
mDocTraversalDepth--;
IndentAndAppendLine("[Comment end]");
mVisitorIsInsideComment = false;
return VisitorAction.Continue;
}
/// <summary>
/// 向 StringBuilder 添加一行,并根据访问者的深度缩进它
/// 进入评论/评论范围的子节点树。
/// </summary>
/// <param name="text"></param>;
private void IndentAndAppendLine(string text)
{
for (int i = 0; i < mDocTraversalDepth; i++)
{
mBuilder.Append("| ");
}
mBuilder.AppendLine(text);
}
private bool mVisitorIsInsideComment;
private int mDocTraversalDepth;
private readonly StringBuilder mBuilder;
}
演示如何使用 DocumentVisitor 实现从文档中删除所有隐藏内容。
public void RemoveHiddenContentFromDocument()
{
Document doc = new Document(MyDir + "Hidden content.docx");
RemoveHiddenContentVisitor hiddenContentRemover = new RemoveHiddenContentVisitor();
// 以下是可以接受文档访问者的三种类型的字段,
// 这将允许它访问接受节点,然后以深度优先的方式遍历其子节点。
// 1 - 段落节点:
Paragraph para = (Paragraph)doc.GetChild(NodeType.Paragraph, 4, true);
para.Accept(hiddenContentRemover);
// 2 - 表节点:
Table table = doc.FirstSection.Body.Tables[0];
table.Accept(hiddenContentRemover);
// 3 - 文档节点:
doc.Accept(hiddenContentRemover);
doc.Save(ArtifactsDir + "Font.RemoveHiddenContentFromDocument.docx");
}
/// <summary>
/// 删除所有标记为“隐藏内容”的已访问节点。
/// </summary>
public class RemoveHiddenContentVisitor : DocumentVisitor
{
/// <summary>
/// 在文档中遇到 FieldStart 节点时调用。
/// </summary>
public override VisitorAction VisitFieldStart(FieldStart fieldStart)
{
if (fieldStart.Font.Hidden)
fieldStart.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 FieldEnd 节点时调用。
/// </summary>
public override VisitorAction VisitFieldEnd(FieldEnd fieldEnd)
{
if (fieldEnd.Font.Hidden)
fieldEnd.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 FieldSeparator 节点时调用。
/// </summary>
public override VisitorAction VisitFieldSeparator(FieldSeparator fieldSeparator)
{
if (fieldSeparator.Font.Hidden)
fieldSeparator.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 Run 节点时调用。
/// </summary>
public override VisitorAction VisitRun(Run run)
{
if (run.Font.Hidden)
run.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到段落节点时调用。
/// </summary>
public override VisitorAction VisitParagraphStart(Paragraph paragraph)
{
if (paragraph.ParagraphBreakFont.Hidden)
paragraph.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 FormField 时调用。
/// </summary>
public override VisitorAction VisitFormField(FormField formField)
{
if (formField.Font.Hidden)
formField.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 GroupShape 时调用。
/// </summary>
public override VisitorAction VisitGroupShapeStart(GroupShape groupShape)
{
if (groupShape.Font.Hidden)
groupShape.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 Shape 时调用。
/// </summary>
public override VisitorAction VisitShapeStart(Shape shape)
{
if (shape.Font.Hidden)
shape.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到注释时调用。
/// </summary>
public override VisitorAction VisitCommentStart(Comment comment)
{
if (comment.Font.Hidden)
comment.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到脚注时调用。
/// </summary>
public override VisitorAction VisitFootnoteStart(Footnote footnote)
{
if (footnote.Font.Hidden)
footnote.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到特殊字符时调用。
/// </summary>
public override VisitorAction VisitSpecialChar(SpecialChar specialChar)
{
if (specialChar.Font.Hidden)
specialChar.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 文档中Table节点访问结束时调用。
/// </summary>
public override VisitorAction VisitTableEnd(Table table)
{
// 表格单元格内的内容可能具有隐藏内容标志,但表格本身不能。
// 如果该表只有隐藏内容,则该访问者将删除所有内容,
// 这样就不会剩下任何子节点了。
// 因此,我们也可以将表格本身视为隐藏内容并将其删除。
// 为空但没有隐藏内容的表格将具有内部带有空段落的单元格,
// 该访问者不会删除它。
if (!table.HasChildNodes)
table.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 文档中某个Cell节点的访问结束时调用。
/// </summary>
public override VisitorAction VisitCellEnd(Cell cell)
{
if (!cell.HasChildNodes && cell.ParentNode != null)
cell.Remove();
return VisitorAction.Continue;
}
/// <summary>
/// 文档中Row节点访问结束时调用。
/// </summary>
public override VisitorAction VisitRowEnd(Row row)
{
if (!row.HasChildNodes && row.ParentNode != null)
row.Remove();
return VisitorAction.Continue;
}
}
也可以看看
- enum VisitorAction
- class Comment
- class DocumentVisitor
- 命名空间 Aspose.Words
- 部件 Aspose.Words