DocumentVisitor

遗产： java.lang.Object

public abstract class DocumentVisitor

自定义文档访问者的基类。

要了解更多信息，请访问**Aspose.Words Document Object Model (DOM)**文档文章。

和DocumentVisitor您可以定义和执行需要对文档树进行枚举的自定义操作。

例如，Aspose.Words 使用DocumentVisitor内部用于保存Document以各种格式和其他操作，如在文档的片段上查找字段或书签。

使用DocumentVisitor:

1. 创建一个派生自的类DocumentVisitor.
2. 覆盖并提供部分或全部 VisitXXX 方法的实现，以执行一些自定义操作。
3. 称呼Node.accept(com.aspose.words.DocumentVisitor)在Node您要从中开始枚举。

DocumentVisitor为所有 VisitXXX 方法提供默认实现，以便更轻松地创建新的文档访问者，因为只有特定访问者所需的方法需要被覆盖。没有必要覆盖所有的访问者方法。

有关更多信息，请参阅访问者设计模式。

方法

方法	描述
equals(Object arg0)
getClass()
hashCode()
notify()
notifyAll()
toString()
visitAbsolutePositionTab(AbsolutePositionTab tab)	当一个AbsolutePositionTab在文档中遇到节点。
visitBodyEnd(Body body)	当一节中主要文本故事的枚举结束时调用。
visitBodyStart(Body body)	当一节中的主要文本故事的枚举开始时调用。
visitBookmarkEnd(BookmarkEnd bookmarkEnd)	在文档中遇到书签结尾时调用。
visitBookmarkStart(BookmarkStart bookmarkStart)	在文档中遇到书签开始时调用。
visitBuildingBlockEnd(BuildingBlock block)	当构建块的枚举结束时调用。
visitBuildingBlockStart(BuildingBlock block)	在开始枚举构建块时调用。
visitCellEnd(Cell cell)	当表格单元格的枚举结束时调用。
visitCellStart(Cell cell)	在开始枚举表格单元格时调用。
visitCommentEnd(Comment comment)	当评论文本的枚举结束时调用。
visitCommentRangeEnd(CommentRangeEnd commentRangeEnd)	当遇到注释文本范围的结尾时调用。
visitCommentRangeStart(CommentRangeStart commentRangeStart)	当遇到注释文本范围的开头时调用。
visitCommentStart(Comment comment)	当注释文本的枚举开始时调用。
visitDocumentEnd(Document doc)	当文档的枚举完成时调用。
visitDocumentStart(Document doc)	当文档的枚举开始时调用。
visitEditableRangeEnd(EditableRangeEnd editableRangeEnd)	在文档中遇到可编辑范围的结尾时调用。
visitEditableRangeStart(EditableRangeStart editableRangeStart)	在文档中遇到可编辑范围的开始时调用。
visitFieldEnd(FieldEnd fieldEnd)	当字段在文档中结束时调用。
visitFieldSeparator(FieldSeparator fieldSeparator)	在文档中遇到字段分隔符时调用。
visitFieldStart(FieldStart fieldStart)	当文档中的字段开始时调用。
visitFootnoteEnd(Footnote footnote)	当脚注或尾注文本的枚举结束时调用。
visitFootnoteStart(Footnote footnote)	当开始枚举脚注或尾注文本时调用。
visitFormField(FormField formField)	在文档中遇到表单域时调用。
visitGlossaryDocumentEnd(GlossaryDocument glossary)	在词汇表文档的枚举结束时调用。
visitGlossaryDocumentStart(GlossaryDocument glossary)	在词汇表文档的枚举开始时调用。
visitGroupShapeEnd(GroupShape groupShape)	当组形状的枚举结束时调用。
visitGroupShapeStart(GroupShape groupShape)	当组形状枚举开始时调用。
visitHeaderFooterEnd(HeaderFooter headerFooter)	当节中页眉或页脚的枚举结束时调用。
visitHeaderFooterStart(HeaderFooter headerFooter)	当节中的页眉或页脚枚举开始时调用。
visitOfficeMathEnd(OfficeMath officeMath)	在 Office Math 对象的枚举结束时调用。
visitOfficeMathStart(OfficeMath officeMath)	在开始枚举 Office Math 对象时调用。
visitParagraphEnd(Paragraph paragraph)	当段落枚举结束时调用。
visitParagraphStart(Paragraph paragraph)	当开始枚举段落时调用。
visitRowEnd(Row row)	当表行的枚举结束时调用。
visitRowStart(Row row)	当表行的枚举开始时调用。
visitRun(Run run)	遇到 中的一段文本时调用。
visitSectionEnd(Section section)	当部分枚举结束时调用。
visitSectionStart(Section section)	当一个部分的枚举开始时调用。
visitShapeEnd(Shape shape)	当形状的枚举结束时调用。
visitShapeStart(Shape shape)	在开始枚举形状时调用。
visitSmartTagEnd(SmartTag smartTag)	当智能标签的枚举结束时调用。
visitSmartTagStart(SmartTag smartTag)	当智能标签的枚举开始时调用。
visitSpecialChar(SpecialChar specialChar)	当一个SpecialChar在文档中遇到节点。
visitStructuredDocumentTagEnd(StructuredDocumentTag sdt)	当结构化文档标签的枚举结束时调用。
visitStructuredDocumentTagRangeEnd(StructuredDocumentTagRangeEnd sdtRangeEnd)
visitStructuredDocumentTagRangeStart(StructuredDocumentTagRangeStart sdtRangeStart)
visitStructuredDocumentTagStart(StructuredDocumentTag sdt)	当结构化文档标签的枚举开始时调用。
visitSubDocument(SubDocument subDocument)	遇到子文档时调用。
visitTableEnd(Table table)	当表的枚举结束时调用。
visitTableStart(Table table)	当表的枚举开始时调用。
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

参数：

范围	类型	描述
arg0	java.lang.Object

退货： 布尔值

getClass()

public final native Class<?> getClass()

退货： java.lang.Class

hashCode()

public native int hashCode()

退货： 整数

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

toString()

public String toString()

退货： java.lang.字符串

visitAbsolutePositionTab(AbsolutePositionTab tab)

public int visitAbsolutePositionTab(AbsolutePositionTab tab)

当一个AbsolutePositionTab在文档中遇到节点。

参数：

范围	类型	描述
tab	AbsolutePositionTab	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitBodyEnd(Body body)

public int visitBodyEnd(Body body)

当一节中主要文本故事的枚举结束时调用。

参数：

范围	类型	描述
body	Body	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitBodyStart(Body body)

public int visitBodyStart(Body body)

当一节中的主要文本故事的枚举开始时调用。

参数：

范围	类型	描述
body	Body	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitBookmarkEnd(BookmarkEnd bookmarkEnd)

public int visitBookmarkEnd(BookmarkEnd bookmarkEnd)

在文档中遇到书签结尾时调用。

参数：

范围	类型	描述
bookmarkEnd	BookmarkEnd	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitBookmarkStart(BookmarkStart bookmarkStart)

public int visitBookmarkStart(BookmarkStart bookmarkStart)

在文档中遇到书签开始时调用。

参数：

范围	类型	描述
bookmarkStart	BookmarkStart	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitBuildingBlockEnd(BuildingBlock block)

public int visitBuildingBlockEnd(BuildingBlock block)

当构建块的枚举结束时调用。

注意：当您对构建块节点执行访问者时，不会访问构建块节点及其子节点Document.如果要在构建块上执行访问者，则需要执行访问者GlossaryDocument或致电BuildingBlock.accept(com.aspose.words.DocumentVisitor).

参数：

范围	类型	描述
block	BuildingBlock	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitBuildingBlockStart(BuildingBlock block)

public int visitBuildingBlockStart(BuildingBlock block)

在开始枚举构建块时调用。

注意：当您对构建块节点执行访问者时，不会访问构建块节点及其子节点Document.如果要在构建块上执行访问者，则需要执行访问者GlossaryDocument或致电BuildingBlock.accept(com.aspose.words.DocumentVisitor).

参数：

范围	类型	描述
block	BuildingBlock	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitCellEnd(Cell cell)

public int visitCellEnd(Cell cell)

当表格单元格的枚举结束时调用。

参数：

范围	类型	描述
cell	Cell	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitCellStart(Cell cell)

public int visitCellStart(Cell cell)

在开始枚举表格单元格时调用。

参数：

范围	类型	描述
cell	Cell	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitCommentEnd(Comment comment)

public int visitCommentEnd(Comment comment)

当评论文本的枚举结束时调用。

参数：

范围	类型	描述
comment	Comment	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitCommentRangeEnd(CommentRangeEnd commentRangeEnd)

public int visitCommentRangeEnd(CommentRangeEnd commentRangeEnd)

当遇到注释文本范围的结尾时调用。

参数：

范围	类型	描述
commentRangeEnd	CommentRangeEnd	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitCommentRangeStart(CommentRangeStart commentRangeStart)

public int visitCommentRangeStart(CommentRangeStart commentRangeStart)

当遇到注释文本范围的开头时调用。

参数：

范围	类型	描述
commentRangeStart	CommentRangeStart	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitCommentStart(Comment comment)

public int visitCommentStart(Comment comment)

当注释文本的枚举开始时调用。

参数：

范围	类型	描述
comment	Comment	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitDocumentEnd(Document doc)

public int visitDocumentEnd(Document doc)

当文档的枚举完成时调用。

参数：

范围	类型	描述
doc	Document	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitDocumentStart(Document doc)

public int visitDocumentStart(Document doc)

当文档的枚举开始时调用。

参数：

范围	类型	描述
doc	Document	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitEditableRangeEnd(EditableRangeEnd editableRangeEnd)

public int visitEditableRangeEnd(EditableRangeEnd editableRangeEnd)

在文档中遇到可编辑范围的结尾时调用。

参数：

范围	类型	描述
editableRangeEnd	EditableRangeEnd	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitEditableRangeStart(EditableRangeStart editableRangeStart)

public int visitEditableRangeStart(EditableRangeStart editableRangeStart)

在文档中遇到可编辑范围的开始时调用。

参数：

范围	类型	描述
editableRangeStart	EditableRangeStart	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitFieldEnd(FieldEnd fieldEnd)

public int visitFieldEnd(FieldEnd fieldEnd)

当字段在文档中结束时调用。

有关更多信息，请参阅visitFieldStart(com.aspose.words.FieldStart)

参数：

范围	类型	描述
fieldEnd	FieldEnd	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitFieldSeparator(FieldSeparator fieldSeparator)

public int visitFieldSeparator(FieldSeparator fieldSeparator)

在文档中遇到字段分隔符时调用。

字段分隔符将文档中的字段代码与字段值分开。请注意，有些字段只有字段代码，没有字段分隔符和字段值。

有关更多信息，请参阅visitFieldStart(com.aspose.words.FieldStart)

参数：

范围	类型	描述
fieldSeparator	FieldSeparator	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitFieldStart(FieldStart fieldStart)

public int visitFieldStart(FieldStart fieldStart)

当文档中的字段开始时调用。

Word 文档中的字段由字段代码和字段值组成。

例如，显示页码的字段可以表示如下：

[FieldStart]PAGE[字段分隔符]98[FieldEnd]

字段分隔符将文档中的字段代码与字段值分开。请注意，有些字段只有字段代码，没有字段分隔符和字段值。

字段可以嵌套。

参数：

范围	类型	描述
fieldStart	FieldStart	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitFootnoteEnd(Footnote footnote)

public int visitFootnoteEnd(Footnote footnote)

当脚注或尾注文本的枚举结束时调用。

参数：

范围	类型	描述
footnote	Footnote	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitFootnoteStart(Footnote footnote)

public int visitFootnoteStart(Footnote footnote)

当开始枚举脚注或尾注文本时调用。

参数：

范围	类型	描述
footnote	Footnote	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitFormField(FormField formField)

public int visitFormField(FormField formField)

在文档中遇到表单域时调用。

参数：

范围	类型	描述
formField	FormField	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitGlossaryDocumentEnd(GlossaryDocument glossary)

public int visitGlossaryDocumentEnd(GlossaryDocument glossary)

在词汇表文档的枚举结束时调用。

注意：当您对词汇表文档节点执行访问者时，不会访问词汇表文档节点及其子节点Document.如果要对词汇表文档执行访问者，则需要调用GlossaryDocument.accept(com.aspose.words.DocumentVisitor).

参数：

范围	类型	描述
glossary	GlossaryDocument	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitGlossaryDocumentStart(GlossaryDocument glossary)

public int visitGlossaryDocumentStart(GlossaryDocument glossary)

在词汇表文档的枚举开始时调用。

注意：当您对词汇表文档节点执行访问者时，不会访问词汇表文档节点及其子节点Document.如果要对词汇表文档执行访问者，则需要调用GlossaryDocument.accept(com.aspose.words.DocumentVisitor).

参数：

范围	类型	描述
glossary	GlossaryDocument	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitGroupShapeEnd(GroupShape groupShape)

public int visitGroupShapeEnd(GroupShape groupShape)

当组形状的枚举结束时调用。

参数：

范围	类型	描述
groupShape	GroupShape	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitGroupShapeStart(GroupShape groupShape)

public int visitGroupShapeStart(GroupShape groupShape)

当组形状枚举开始时调用。

参数：

范围	类型	描述
groupShape	GroupShape	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitHeaderFooterEnd(HeaderFooter headerFooter)

public int visitHeaderFooterEnd(HeaderFooter headerFooter)

当节中页眉或页脚的枚举结束时调用。

参数：

范围	类型	描述
headerFooter	HeaderFooter	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitHeaderFooterStart(HeaderFooter headerFooter)

public int visitHeaderFooterStart(HeaderFooter headerFooter)

当节中的页眉或页脚枚举开始时调用。

参数：

范围	类型	描述
headerFooter	HeaderFooter	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitOfficeMathEnd(OfficeMath officeMath)

public int visitOfficeMathEnd(OfficeMath officeMath)

在 Office Math 对象的枚举结束时调用。

参数：

范围	类型	描述
officeMath	OfficeMath	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitOfficeMathStart(OfficeMath officeMath)

public int visitOfficeMathStart(OfficeMath officeMath)

在开始枚举 Office Math 对象时调用。

参数：

范围	类型	描述
officeMath	OfficeMath	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitParagraphEnd(Paragraph paragraph)

public int visitParagraphEnd(Paragraph paragraph)

当段落枚举结束时调用。

参数：

范围	类型	描述
paragraph	Paragraph	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitParagraphStart(Paragraph paragraph)

public int visitParagraphStart(Paragraph paragraph)

当开始枚举段落时调用。

参数：

范围	类型	描述
paragraph	Paragraph	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitRowEnd(Row row)

public int visitRowEnd(Row row)

当表行的枚举结束时调用。

参数：

范围	类型	描述
row	Row	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitRowStart(Row row)

public int visitRowStart(Row row)

当表行的枚举开始时调用。

参数：

范围	类型	描述
row	Row	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitRun(Run run)

public int visitRun(Run run)

遇到 中的一段文本时调用。

参数：

范围	类型	描述
run	Run	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitSectionEnd(Section section)

public int visitSectionEnd(Section section)

当部分枚举结束时调用。

参数：

范围	类型	描述
section	Section	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitSectionStart(Section section)

public int visitSectionStart(Section section)

当一个部分的枚举开始时调用。

参数：

范围	类型	描述
section	Section	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitShapeEnd(Shape shape)

public int visitShapeEnd(Shape shape)

当形状的枚举结束时调用。

参数：

范围	类型	描述
shape	Shape	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitShapeStart(Shape shape)

public int visitShapeStart(Shape shape)

在开始枚举形状时调用。

参数：

范围	类型	描述
shape	Shape	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitSmartTagEnd(SmartTag smartTag)

public int visitSmartTagEnd(SmartTag smartTag)

当智能标签的枚举结束时调用。

参数：

范围	类型	描述
smartTag	SmartTag	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitSmartTagStart(SmartTag smartTag)

public int visitSmartTagStart(SmartTag smartTag)

当智能标签的枚举开始时调用。

参数：

范围	类型	描述
smartTag	SmartTag	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitSpecialChar(SpecialChar specialChar)

public int visitSpecialChar(SpecialChar specialChar)

当一个SpecialChar在文档中遇到节点。

参数：

范围	类型	描述
specialChar	SpecialChar	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。通用控制字符不会调用此方法（请参阅ControlChar可以出现在文档中。

visitStructuredDocumentTagEnd(StructuredDocumentTag sdt)

public int visitStructuredDocumentTagEnd(StructuredDocumentTag sdt)

当结构化文档标签的枚举结束时调用。

参数：

范围	类型	描述
sdt	StructuredDocumentTag	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitStructuredDocumentTagRangeEnd(StructuredDocumentTagRangeEnd sdtRangeEnd)

public int visitStructuredDocumentTagRangeEnd(StructuredDocumentTagRangeEnd sdtRangeEnd)

参数：

范围	类型	描述
sdtRangeEnd	StructuredDocumentTagRangeEnd

退货： 整数

visitStructuredDocumentTagRangeStart(StructuredDocumentTagRangeStart sdtRangeStart)

public int visitStructuredDocumentTagRangeStart(StructuredDocumentTagRangeStart sdtRangeStart)

参数：

范围	类型	描述
sdtRangeStart	StructuredDocumentTagRangeStart

退货： 整数

visitStructuredDocumentTagStart(StructuredDocumentTag sdt)

public int visitStructuredDocumentTagStart(StructuredDocumentTag sdt)

当结构化文档标签的枚举开始时调用。

参数：

范围	类型	描述
sdt	StructuredDocumentTag	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitSubDocument(SubDocument subDocument)

public int visitSubDocument(SubDocument subDocument)

遇到子文档时调用。

参数：

范围	类型	描述
subDocument	SubDocument	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitTableEnd(Table table)

public int visitTableEnd(Table table)

当表的枚举结束时调用。

参数：

范围	类型	描述
table	Table	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

visitTableStart(Table table)

public int visitTableStart(Table table)

当表的枚举开始时调用。

参数：

范围	类型	描述
table	Table	正在访问的对象。

退货： 诠释 - AVisitorAction指定如何继续枚举的值。返回值是其中之一VisitorAction常数。

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

参数：

范围	类型	描述
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

参数：

范围	类型	描述
arg0	long
arg1	int