DocumentVisitor
Overview
DocumentVisitor is a class in Aspose.Words FOSS for Java.
Base class for custom document visitors.
Edition status of its 50 listed members (a property and its accessor methods are listed separately, overloads once): 50 not yet exercised by a verified example.
This class declares 50 methods for DocumentVisitor objects in Java programs.
Available methods include: visitAbsolutePositionTab, visitBodyEnd, visitBodyStart, visitBookmarkEnd, visitBookmarkStart, visitBuildingBlockEnd, visitBuildingBlockStart, visitCellEnd, visitCellStart, visitCommentEnd, visitCommentRangeEnd, visitCommentRangeStart, and 38 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Methods
| Signature | Description |
|---|---|
visitDocumentStart(doc: Document) → int | Called when enumeration of the document has started. |
visitDocumentEnd(doc: Document) → int | Called when enumeration of the document has finished. |
visitSectionStart(section: Section) → int | Called when enumeration of a section has started. |
visitSectionEnd(section: Section) → int | Called when enumeration of a section has ended. |
visitBodyStart(body: Body) → int | Called when enumeration of the main text story in a section has started. |
visitBodyEnd(body: Body) → int | Called when enumeration of the main text story in a section has ended. |
visitHeaderFooterStart(headerFooter: HeaderFooter) → int | Called when enumeration of a header or footer in a section has started. |
visitHeaderFooterEnd(headerFooter: HeaderFooter) → int | Called when enumeration of a header or footer in a section has ended. |
visitParagraphStart(paragraph: Paragraph) → int | Called when enumeration of a paragraph has started. |
visitParagraphEnd(paragraph: Paragraph) → int | Called when enumeration of a paragraph has ended. |
visitTableStart(table: Table) → int | Called when enumeration of a table has started. |
visitTableEnd(table: Table) → int | Called when enumeration of a table has ended. |
visitRowStart(row: Row) → int | Called when enumeration of a table row has started. |
visitRowEnd(row: Row) → int | Called when enumeration of a table row has ended. |
visitCellStart(cell: Cell) → int | Called when enumeration of a table cell has started. |
visitCellEnd(cell: Cell) → int | Called when enumeration of a table cell has ended. |
visitRun(run: Run) → int | Called when a run of text in the is encountered. |
visitFieldStart(fieldStart: FieldStart) → int | Called when a field starts in the document. |
visitFieldSeparator(fieldSeparator: FieldSeparator) → int | Called when a field separator is encountered in the document. |
visitFieldEnd(fieldEnd: FieldEnd) → int | Called when a field ends in the document. |
visitFormField(formField: FormField) → int | Called when a form field is encountered in the document. |
visitBookmarkStart(bookmarkStart: BookmarkStart) → int | Called when a start of a bookmark is encountered in the document. |
visitBookmarkEnd(bookmarkEnd: BookmarkEnd) → int | Called when an end of a bookmark is encountered in the document. |
visitFootnoteStart(footnote: Footnote) → int | Called when enumeration of a footnote or endnote text has started. |
visitFootnoteEnd(footnote: Footnote) → int | Called when enumeration of a footnote or endnote text has ended. |
visitCommentStart(comment: Comment) → int | Called when enumeration of a comment text has started. |
visitCommentEnd(comment: Comment) → int | Called when enumeration of a comment text has ended. |
visitEditableRangeStart(editableRangeStart: EditableRangeStart) → int | Called when a start of an editable range is encountered in the document. |
visitEditableRangeEnd(editableRangeEnd: EditableRangeEnd) → int | Called when an end of an editable range is encountered in the document. |
visitShapeStart(shape: Shape) → int | Called when enumeration of a shape has started. |
visitShapeEnd(shape: Shape) → int | Called when enumeration of a shape has ended. |
visitGroupShapeStart(groupShape: GroupShape) → int | Called when enumeration of a group shape has started. |
visitGroupShapeEnd(groupShape: GroupShape) → int | Called when enumeration of a group shape has ended. |
visitOfficeMathStart(officeMath: OfficeMath) → int | Called when enumeration of a Office Math object has started. |
visitOfficeMathEnd(officeMath: OfficeMath) → int | Called when enumeration of a Office Math object has ended. |
visitSpecialChar(specialChar: SpecialChar) → int | Called when a SpecialChar node is encountered in the document. |
visitAbsolutePositionTab(tab: AbsolutePositionTab) → int | Called when a AbsolutePositionTab node is encountered in the document. |
visitSmartTagStart(smartTag: SmartTag) → int | Called when enumeration of a smart tag has started. |
visitSmartTagEnd(smartTag: SmartTag) → int | Called when enumeration of a smart tag has ended. |
visitStructuredDocumentTagStart(sdt: StructuredDocumentTag) → int | Called when enumeration of a structured document tag has started. |
visitStructuredDocumentTagEnd(sdt: StructuredDocumentTag) → int | Called when enumeration of a structured document tag has ended. |
visitGlossaryDocumentStart(glossary: GlossaryDocument) → int | Called when enumeration of a glossary document has started. |
visitGlossaryDocumentEnd(glossary: GlossaryDocument) → int | Called when enumeration of a glossary document has ended. |
visitBuildingBlockStart(block: BuildingBlock) → int | Called when enumeration of a building block has started. |
visitBuildingBlockEnd(block: BuildingBlock) → int | Called when enumeration of a building block has ended. |
visitCommentRangeStart(commentRangeStart: CommentRangeStart) → int | Called when the start of a commented range of text is encountered. |
visitCommentRangeEnd(commentRangeEnd: CommentRangeEnd) → int | Called when the end of a commented range of text is encountered. |
visitSubDocument(subDocument: SubDocument) → int | Called when a sub-document is encountered. |
visitStructuredDocumentTagRangeStart(sdtRangeStart: StructuredDocumentTagRangeStart) → int | Called when a StructuredDocumentTagRangeStart is encountered. |
visitStructuredDocumentTagRangeEnd(sdtRangeEnd: StructuredDocumentTagRangeEnd) → int | Called when a StructuredDocumentTagRangeEnd is encountered. |