DocumentVisitor

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

SignatureDescription
visitDocumentStart(doc: Document) → intCalled when enumeration of the document has started.
visitDocumentEnd(doc: Document) → intCalled when enumeration of the document has finished.
visitSectionStart(section: Section) → intCalled when enumeration of a section has started.
visitSectionEnd(section: Section) → intCalled when enumeration of a section has ended.
visitBodyStart(body: Body) → intCalled when enumeration of the main text story in a section has started.
visitBodyEnd(body: Body) → intCalled when enumeration of the main text story in a section has ended.
visitHeaderFooterStart(headerFooter: HeaderFooter) → intCalled when enumeration of a header or footer in a section has started.
visitHeaderFooterEnd(headerFooter: HeaderFooter) → intCalled when enumeration of a header or footer in a section has ended.
visitParagraphStart(paragraph: Paragraph) → intCalled when enumeration of a paragraph has started.
visitParagraphEnd(paragraph: Paragraph) → intCalled when enumeration of a paragraph has ended.
visitTableStart(table: Table) → intCalled when enumeration of a table has started.
visitTableEnd(table: Table) → intCalled when enumeration of a table has ended.
visitRowStart(row: Row) → intCalled when enumeration of a table row has started.
visitRowEnd(row: Row) → intCalled when enumeration of a table row has ended.
visitCellStart(cell: Cell) → intCalled when enumeration of a table cell has started.
visitCellEnd(cell: Cell) → intCalled when enumeration of a table cell has ended.
visitRun(run: Run) → intCalled when a run of text in the is encountered.
visitFieldStart(fieldStart: FieldStart) → intCalled when a field starts in the document.
visitFieldSeparator(fieldSeparator: FieldSeparator) → intCalled when a field separator is encountered in the document.
visitFieldEnd(fieldEnd: FieldEnd) → intCalled when a field ends in the document.
visitFormField(formField: FormField) → intCalled when a form field is encountered in the document.
visitBookmarkStart(bookmarkStart: BookmarkStart) → intCalled when a start of a bookmark is encountered in the document.
visitBookmarkEnd(bookmarkEnd: BookmarkEnd) → intCalled when an end of a bookmark is encountered in the document.
visitFootnoteStart(footnote: Footnote) → intCalled when enumeration of a footnote or endnote text has started.
visitFootnoteEnd(footnote: Footnote) → intCalled when enumeration of a footnote or endnote text has ended.
visitCommentStart(comment: Comment) → intCalled when enumeration of a comment text has started.
visitCommentEnd(comment: Comment) → intCalled when enumeration of a comment text has ended.
visitEditableRangeStart(editableRangeStart: EditableRangeStart) → intCalled when a start of an editable range is encountered in the document.
visitEditableRangeEnd(editableRangeEnd: EditableRangeEnd) → intCalled when an end of an editable range is encountered in the document.
visitShapeStart(shape: Shape) → intCalled when enumeration of a shape has started.
visitShapeEnd(shape: Shape) → intCalled when enumeration of a shape has ended.
visitGroupShapeStart(groupShape: GroupShape) → intCalled when enumeration of a group shape has started.
visitGroupShapeEnd(groupShape: GroupShape) → intCalled when enumeration of a group shape has ended.
visitOfficeMathStart(officeMath: OfficeMath) → intCalled when enumeration of a Office Math object has started.
visitOfficeMathEnd(officeMath: OfficeMath) → intCalled when enumeration of a Office Math object has ended.
visitSpecialChar(specialChar: SpecialChar) → intCalled when a SpecialChar node is encountered in the document.
visitAbsolutePositionTab(tab: AbsolutePositionTab) → intCalled when a AbsolutePositionTab node is encountered in the document.
visitSmartTagStart(smartTag: SmartTag) → intCalled when enumeration of a smart tag has started.
visitSmartTagEnd(smartTag: SmartTag) → intCalled when enumeration of a smart tag has ended.
visitStructuredDocumentTagStart(sdt: StructuredDocumentTag) → intCalled when enumeration of a structured document tag has started.
visitStructuredDocumentTagEnd(sdt: StructuredDocumentTag) → intCalled when enumeration of a structured document tag has ended.
visitGlossaryDocumentStart(glossary: GlossaryDocument) → intCalled when enumeration of a glossary document has started.
visitGlossaryDocumentEnd(glossary: GlossaryDocument) → intCalled when enumeration of a glossary document has ended.
visitBuildingBlockStart(block: BuildingBlock) → intCalled when enumeration of a building block has started.
visitBuildingBlockEnd(block: BuildingBlock) → intCalled when enumeration of a building block has ended.
visitCommentRangeStart(commentRangeStart: CommentRangeStart) → intCalled when the start of a commented range of text is encountered.
visitCommentRangeEnd(commentRangeEnd: CommentRangeEnd) → intCalled when the end of a commented range of text is encountered.
visitSubDocument(subDocument: SubDocument) → intCalled when a sub-document is encountered.
visitStructuredDocumentTagRangeStart(sdtRangeStart: StructuredDocumentTagRangeStart) → intCalled when a StructuredDocumentTagRangeStart is encountered.
visitStructuredDocumentTagRangeEnd(sdtRangeEnd: StructuredDocumentTagRangeEnd) → intCalled when a StructuredDocumentTagRangeEnd is encountered.

See Also