DocumentVisitor (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.DocumentVisitor

```
public abstract class DocumentVisitor
extends java.lang.Object
```
Base class for custom document visitors.
To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

With DocumentVisitor you can define and execute custom operations that require enumeration over the document tree.

For example, Aspose.Words uses DocumentVisitor internally for saving Document in various formats and for other operations like finding fields or bookmarks over a fragment of a document.

To use DocumentVisitor:
1. Create a class derived from DocumentVisitor.
2. Override and provide implementations for some or all of the VisitXXX methods to perform some custom operations.
3. Call Node.accept(com.aspose.words.DocumentVisitor) on the Node that you want to start the enumeration from.
DocumentVisitor provides default implementations for all of the VisitXXX methods to make it easier to create new document visitors as only the methods required for the particular visitor need to be overridden. It is not necessary to override all of the visitor methods.

For more information see the Visitor design pattern.

Constructor Summary

Constructors
Modifier Constructor and Description

protected DocumentVisitor()
Initializes a new instance of this class.

Constructors
Modifier	Constructor and Description
`protected`	`DocumentVisitor()` Initializes a new instance of this class.

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentVisitor
```
protected DocumentVisitor()
```
    Initializes a new instance of this class.
- Method Detail
  - visitDocumentStart
```
public int visitDocumentStart(Document doc)
                       throws java.lang.Exception
```
    Called when enumeration of the document has started.
    
    Parameters:
    
    doc - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitDocumentEnd
```
public int visitDocumentEnd(Document doc)
                     throws java.lang.Exception
```
    Called when enumeration of the document has finished.
    
    Parameters:
    
    doc - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitSectionStart
```
public int visitSectionStart(Section section)
                      throws java.lang.Exception
```
    Called when enumeration of a section has started.
    
    Parameters:
    
    section - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitSectionEnd
```
public int visitSectionEnd(Section section)
                    throws java.lang.Exception
```
    Called when enumeration of a section has ended.
    
    Parameters:
    
    section - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitBodyStart
```
public int visitBodyStart(Body body)
                   throws java.lang.Exception
```
    Called when enumeration of the main text story in a section has started.
    
    Parameters:
    
    body - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitBodyEnd
```
public int visitBodyEnd(Body body)
                 throws java.lang.Exception
```
    Called when enumeration of the main text story in a section has ended.
    
    Parameters:
    
    body - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitHeaderFooterStart
```
public int visitHeaderFooterStart(HeaderFooter headerFooter)
                           throws java.lang.Exception
```
    Called when enumeration of a header or footer in a section has started.
    
    Parameters:
    
    headerFooter - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitHeaderFooterEnd
```
public int visitHeaderFooterEnd(HeaderFooter headerFooter)
                         throws java.lang.Exception
```
    Called when enumeration of a header or footer in a section has ended.
    
    Parameters:
    
    headerFooter - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitParagraphStart
```
public int visitParagraphStart(Paragraph paragraph)
                        throws java.lang.Exception
```
    Called when enumeration of a paragraph has started.
    
    Parameters:
    
    paragraph - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitParagraphEnd
```
public int visitParagraphEnd(Paragraph paragraph)
                      throws java.lang.Exception
```
    Called when enumeration of a paragraph has ended.
    
    Parameters:
    
    paragraph - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitTableStart
```
public int visitTableStart(Table table)
                    throws java.lang.Exception
```
    Called when enumeration of a table has started.
    
    Parameters:
    
    table - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitTableEnd
```
public int visitTableEnd(Table table)
                  throws java.lang.Exception
```
    Called when enumeration of a table has ended.
    
    Parameters:
    
    table - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitRowStart
```
public int visitRowStart(Row row)
                  throws java.lang.Exception
```
    Called when enumeration of a table row has started.
    
    Parameters:
    
    row - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitRowEnd
```
public int visitRowEnd(Row row)
                throws java.lang.Exception
```
    Called when enumeration of a table row has ended.
    
    Parameters:
    
    row - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitCellStart
```
public int visitCellStart(Cell cell)
                   throws java.lang.Exception
```
    Called when enumeration of a table cell has started.
    
    Parameters:
    
    cell - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitCellEnd
```
public int visitCellEnd(Cell cell)
                 throws java.lang.Exception
```
    Called when enumeration of a table cell has ended.
    
    Parameters:
    
    cell - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitRun
```
public int visitRun(Run run)
             throws java.lang.Exception
```
    Called when a run of text in the is encountered.
    
    Parameters:
    
    run - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitFieldStart
```
public int visitFieldStart(FieldStart fieldStart)
                    throws java.lang.Exception
```
    Called when a field starts in the document.
    A field in a Word document consists of a field code and field value.
    
    For example, a field that displays a page number can be represented as follows:
    
    [FieldStart]PAGE[FieldSeparator]98[FieldEnd]
    
    The field separator separates field code from field value in the document. Note that some fields have only field code and do not have field separator and field value.
    
    Fields can be nested.
    
    Parameters:
    
    fieldStart - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitFieldSeparator
```
public int visitFieldSeparator(FieldSeparator fieldSeparator)
                        throws java.lang.Exception
```
    Called when a field separator is encountered in the document.
    The field separator separates field code from field value in the document. Note that some fields have only field code and do not have field separator and field value.
    
    For more info see visitFieldStart(com.aspose.words.FieldStart)
    
    Parameters:
    
    fieldSeparator - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitFieldEnd
```
public int visitFieldEnd(FieldEnd fieldEnd)
                  throws java.lang.Exception
```
    Called when a field ends in the document.
    For more info see visitFieldStart(com.aspose.words.FieldStart)
    
    Parameters:
    
    fieldEnd - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitFormField
```
public int visitFormField(FormField formField)
                   throws java.lang.Exception
```
    Called when a form field is encountered in the document.
    
    Parameters:
    
    formField - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitBookmarkStart
```
public int visitBookmarkStart(BookmarkStart bookmarkStart)
                       throws java.lang.Exception
```
    Called when a start of a bookmark is encountered in the document.
    
    Parameters:
    
    bookmarkStart - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitBookmarkEnd
```
public int visitBookmarkEnd(BookmarkEnd bookmarkEnd)
                     throws java.lang.Exception
```
    Called when an end of a bookmark is encountered in the document.
    
    Parameters:
    
    bookmarkEnd - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitFootnoteStart
```
public int visitFootnoteStart(Footnote footnote)
                       throws java.lang.Exception
```
    Called when enumeration of a footnote or endnote text has started.
    
    Parameters:
    
    footnote - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitFootnoteEnd
```
public int visitFootnoteEnd(Footnote footnote)
                     throws java.lang.Exception
```
    Called when enumeration of a footnote or endnote text has ended.
    
    Parameters:
    
    footnote - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitCommentStart
```
public int visitCommentStart(Comment comment)
                      throws java.lang.Exception
```
    Called when enumeration of a comment text has started.
    
    Parameters:
    
    comment - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitCommentEnd
```
public int visitCommentEnd(Comment comment)
                    throws java.lang.Exception
```
    Called when enumeration of a comment text has ended.
    
    Parameters:
    
    comment - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitEditableRangeStart
```
public int visitEditableRangeStart(EditableRangeStart editableRangeStart)
                            throws java.lang.Exception
```
    Called when a start of an editable range is encountered in the document.
    
    Parameters:
    
    editableRangeStart - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitEditableRangeEnd
```
public int visitEditableRangeEnd(EditableRangeEnd editableRangeEnd)
                          throws java.lang.Exception
```
    Called when an end of an editable range is encountered in the document.
    
    Parameters:
    
    editableRangeEnd - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitShapeStart
```
public int visitShapeStart(Shape shape)
                    throws java.lang.Exception
```
    Called when enumeration of a shape has started.
    
    Parameters:
    
    shape - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitShapeEnd
```
public int visitShapeEnd(Shape shape)
                  throws java.lang.Exception
```
    Called when enumeration of a shape has ended.
    
    Parameters:
    
    shape - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitGroupShapeStart
```
public int visitGroupShapeStart(GroupShape groupShape)
                         throws java.lang.Exception
```
    Called when enumeration of a group shape has started.
    
    Parameters:
    
    groupShape - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitGroupShapeEnd
```
public int visitGroupShapeEnd(GroupShape groupShape)
                       throws java.lang.Exception
```
    Called when enumeration of a group shape has ended.
    
    Parameters:
    
    groupShape - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitOfficeMathStart
```
public int visitOfficeMathStart(OfficeMath officeMath)
                         throws java.lang.Exception
```
    Called when enumeration of a Office Math object has started.
    
    Parameters:
    
    officeMath - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitOfficeMathEnd
```
public int visitOfficeMathEnd(OfficeMath officeMath)
                       throws java.lang.Exception
```
    Called when enumeration of a Office Math object has ended.
    
    Parameters:
    
    officeMath - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitSpecialChar
```
public int visitSpecialChar(SpecialChar specialChar)
                     throws java.lang.Exception
```
    Called when a SpecialChar node is encountered in the document.
    
    Parameters:
    
    specialChar - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitAbsolutePositionTab
```
public int visitAbsolutePositionTab(AbsolutePositionTab tab)
                             throws java.lang.Exception
```
    Called when a AbsolutePositionTab node is encountered in the document.
    
    Parameters:
    
    tab - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitSmartTagStart
```
public int visitSmartTagStart(SmartTag smartTag)
                       throws java.lang.Exception
```
    Called when enumeration of a smart tag has started.
    
    Parameters:
    
    smartTag - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitSmartTagEnd
```
public int visitSmartTagEnd(SmartTag smartTag)
                     throws java.lang.Exception
```
    Called when enumeration of a smart tag has ended.
    
    Parameters:
    
    smartTag - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitStructuredDocumentTagStart
```
public int visitStructuredDocumentTagStart(StructuredDocumentTag sdt)
                                    throws java.lang.Exception
```
    Called when enumeration of a structured document tag has started.
    
    Parameters:
    
    sdt - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitStructuredDocumentTagEnd
```
public int visitStructuredDocumentTagEnd(StructuredDocumentTag sdt)
                                  throws java.lang.Exception
```
    Called when enumeration of a structured document tag has ended.
    
    Parameters:
    
    sdt - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitGlossaryDocumentStart
```
public int visitGlossaryDocumentStart(GlossaryDocument glossary)
                               throws java.lang.Exception
```
    Called when enumeration of a glossary document has started.
    Note: A glossary document node and its children are not visited when you execute a Visitor over a Document. If you want to execute a Visitor over a glossary document, you need to call GlossaryDocument.accept(com.aspose.words.DocumentVisitor).
    
    Parameters:
    
    glossary - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitGlossaryDocumentEnd
```
public int visitGlossaryDocumentEnd(GlossaryDocument glossary)
                             throws java.lang.Exception
```
    Called when enumeration of a glossary document has ended.
    Note: A glossary document node and its children are not visited when you execute a Visitor over a Document. If you want to execute a Visitor over a glossary document, you need to call GlossaryDocument.accept(com.aspose.words.DocumentVisitor).
    
    Parameters:
    
    glossary - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitBuildingBlockStart
```
public int visitBuildingBlockStart(BuildingBlock block)
                            throws java.lang.Exception
```
    Called when enumeration of a building block has started.
    Note: A building block node and its children are not visited when you execute a Visitor over a Document. If you want to execute a Visitor over a building block, you need to execute the visitor over GlossaryDocument or call BuildingBlock.accept(com.aspose.words.DocumentVisitor).
    
    Parameters:
    
    block - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitBuildingBlockEnd
```
public int visitBuildingBlockEnd(BuildingBlock block)
                          throws java.lang.Exception
```
    Called when enumeration of a building block has ended.
    Note: A building block node and its children are not visited when you execute a Visitor over a Document. If you want to execute a Visitor over a building block, you need to execute the visitor over GlossaryDocument or call BuildingBlock.accept(com.aspose.words.DocumentVisitor).
    
    Parameters:
    
    block - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitCommentRangeStart
```
public int visitCommentRangeStart(CommentRangeStart commentRangeStart)
                           throws java.lang.Exception
```
    Called when the start of a commented range of text is encountered.
    
    Parameters:
    
    commentRangeStart - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitCommentRangeEnd
```
public int visitCommentRangeEnd(CommentRangeEnd commentRangeEnd)
                         throws java.lang.Exception
```
    Called when the end of a commented range of text is encountered.
    
    Parameters:
    
    commentRangeEnd - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitSubDocument
```
public int visitSubDocument(SubDocument subDocument)
                     throws java.lang.Exception
```
    Called when a subDocument is encountered.
    
    Parameters:
    
    subDocument - The object that is being visited.
    
    Returns:
    
    A VisitorAction value that specifies how to continue the enumeration. The returned value is one of VisitorAction constants.
    
    Throws:
    
    java.lang.Exception
  - visitStructuredDocumentTagRangeStart
```
public int visitStructuredDocumentTagRangeStart(StructuredDocumentTagRangeStart sdtRangeStart)
                                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - visitStructuredDocumentTagRangeEnd
```
public int visitStructuredDocumentTagRangeEnd(StructuredDocumentTagRangeEnd sdtRangeEnd)
                                       throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception

Class DocumentVisitor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentVisitor

Method Detail

visitDocumentStart

visitDocumentEnd

visitSectionStart

visitSectionEnd

visitBodyStart

visitBodyEnd

visitHeaderFooterStart

visitHeaderFooterEnd

visitParagraphStart

visitParagraphEnd

visitTableStart

visitTableEnd

visitRowStart

visitRowEnd

visitCellStart

visitCellEnd

visitRun

visitFieldStart

visitFieldSeparator

visitFieldEnd

visitFormField

visitBookmarkStart

visitBookmarkEnd

visitFootnoteStart

visitFootnoteEnd

visitCommentStart

visitCommentEnd

visitEditableRangeStart

visitEditableRangeEnd

visitShapeStart

visitShapeEnd

visitGroupShapeStart

visitGroupShapeEnd

visitOfficeMathStart

visitOfficeMathEnd

visitSpecialChar

visitAbsolutePositionTab

visitSmartTagStart

visitSmartTagEnd

visitStructuredDocumentTagStart

visitStructuredDocumentTagEnd

visitGlossaryDocumentStart

visitGlossaryDocumentEnd

visitBuildingBlockStart

visitBuildingBlockEnd

visitCommentRangeStart

visitCommentRangeEnd

visitSubDocument

visitStructuredDocumentTagRangeStart

visitStructuredDocumentTagRangeEnd