DocumentVisitor
内容
[
隐藏
]DocumentVisitor class
自定义文档访问者的基类。
要了解更多信息,请访问Aspose.Words 文档对象模型(DOM)文档文章。
public abstract class DocumentVisitor
方法
评论
和DocumentVisitor
您可以定义并执行需要对文档树进行枚举的自定义操作 。
例如,Aspose.Words 使用DocumentVisitor
内部保存Document
以各种格式和其他操作(如在文档片段上查找字段或书签)。
使用DocumentVisitor
:
DocumentVisitor
为所有 VisitXXX 方法 提供默认实现,以便于创建新的文档访问者,因为只需重写特定 访问者所需的方法即可。无需重写所有访问者方法。
有关详细信息,请参阅访问者设计模式。
例子
展示如何使用文档访问器打印文档的节点结构。
public void DocStructureToText()
{
Document doc = new Document(MyDir + "DocumentVisitor-compatible features.docx");
DocStructurePrinter visitor = new DocStructurePrinter();
// 当我们得到一个复合节点来接受文档访问者时,访问者会访问接受节点,
// 然后以深度优先的方式遍历该节点的所有子节点。
// 访问者可以读取和修改每个访问的节点。
doc.Accept(visitor);
Console.WriteLine(visitor.GetText());
}
/// <summary>
/// 遍历节点的子节点树。
/// 以字符串的形式创建这棵树的映射。
/// </summary>
public class DocStructurePrinter : DocumentVisitor
{
public DocStructurePrinter()
{
mAcceptingNodeChildTree = new StringBuilder();
}
public string GetText()
{
return mAcceptingNodeChildTree.ToString();
}
/// <summary>
/// 当遇到 Document 节点时调用。
/// </summary>
public override VisitorAction VisitDocumentStart(Document doc)
{
int childNodeCount = doc.GetChildNodes(NodeType.Any, true).Count;
IndentAndAppendLine("[Document start] Child nodes: " + childNodeCount);
mDocTraversalDepth++;
// 允许访问者继续访问其他节点。
return VisitorAction.Continue;
}
/// <summary>
/// 在访问完 Document 节点的所有子节点后调用。
/// </summary>
public override VisitorAction VisitDocumentEnd(Document doc)
{
mDocTraversalDepth--;
IndentAndAppendLine("[Document end]");
return VisitorAction.Continue;
}
/// <summary>
/// 当在文档中遇到 Section 节点时调用。
/// </summary>
public override VisitorAction VisitSectionStart(Section section)
{
// 获取文档中我们部分的索引。
NodeCollection docSections = section.Document.GetChildNodes(NodeType.Section, false);
int sectionIndex = docSections.IndexOf(section);
IndentAndAppendLine("[Section start] Section index: " + sectionIndex);
mDocTraversalDepth++;
return VisitorAction.Continue;
}
/// <summary>
/// 在访问完 Section 节点的所有子节点后调用。
/// </summary>
public override VisitorAction VisitSectionEnd(Section section)
{
mDocTraversalDepth--;
IndentAndAppendLine("[Section end]");
return VisitorAction.Continue;
}
/// <summary>
/// 当在文档中遇到 Body 节点时调用。
/// </summary>
public override VisitorAction VisitBodyStart(Body body)
{
int paragraphCount = body.Paragraphs.Count;
IndentAndAppendLine("[Body start] Paragraphs: " + paragraphCount);
mDocTraversalDepth++;
return VisitorAction.Continue;
}
/// <summary>
/// 在访问完 Body 节点的所有子节点后调用。
/// </summary>
public override VisitorAction VisitBodyEnd(Body body)
{
mDocTraversalDepth--;
IndentAndAppendLine("[Body end]");
return VisitorAction.Continue;
}
/// <summary>
/// 当在文档中遇到段落节点时调用。
/// </summary>
public override VisitorAction VisitParagraphStart(Paragraph paragraph)
{
IndentAndAppendLine("[Paragraph start]");
mDocTraversalDepth++;
return VisitorAction.Continue;
}
/// <summary>
/// 在访问完 Paragraph 节点的所有子节点后调用。
/// </summary>
public override VisitorAction VisitParagraphEnd(Paragraph paragraph)
{
mDocTraversalDepth--;
IndentAndAppendLine("[Paragraph end]");
return VisitorAction.Continue;
}
/// <summary>
/// 在文档中遇到 Run 节点时调用。
/// </summary>
public override VisitorAction VisitRun(Run run)
{
IndentAndAppendLine("[Run] \"" + run.GetText() + "\"");
return VisitorAction.Continue;
}
/// <summary>
/// 当在文档中遇到 SubDocument 节点时调用。
/// </summary>
public override VisitorAction VisitSubDocument(SubDocument subDocument)
{
IndentAndAppendLine("[SubDocument]");
return VisitorAction.Continue;
}
/// <summary>
/// 当在文档中遇到 SubDocument 节点时调用。
/// </summary>
public override VisitorAction VisitStructuredDocumentTagRangeStart(StructuredDocumentTagRangeStart sdtRangeStart)
{
IndentAndAppendLine("[SdtRangeStart]");
return VisitorAction.Continue;
}
/// <summary>
/// 当在文档中遇到 SubDocument 节点时调用。
/// </summary>
public override VisitorAction VisitStructuredDocumentTagRangeEnd(StructuredDocumentTagRangeEnd sdtRangeEnd)
{
IndentAndAppendLine("[SdtRangeEnd]");
return VisitorAction.Continue;
}
/// <summary>
/// 向 StringBuilder 附加一行并根据访问者在文档树中的深度进行缩进。
/// </summary>
/// <param name="text"></param>
private void IndentAndAppendLine(string text)
{
for (int i = 0; i < mDocTraversalDepth; i++) mAcceptingNodeChildTree.Append("| ");
mAcceptingNodeChildTree.AppendLine(text);
}
private int mDocTraversalDepth;
private readonly StringBuilder mAcceptingNodeChildTree;
}
也可以看看
- 命名空间 Aspose.Words
- 部件 Aspose.Words