Aspose::Words::DocumentVisitor Class Reference

Base class for custom document visitors. More...

#include "Aspose.Words.Cpp/Model/Document/DocumentVisitor.h"

Inherits System::Object.

Public Member Functions

virtual Aspose::Words::VisitorAction VisitDocumentStart (System::SharedPtr< Aspose::Words::Document > doc)
 Called when enumeration of the document has started. More...
 
virtual Aspose::Words::VisitorAction VisitDocumentEnd (System::SharedPtr< Aspose::Words::Document > doc)
 Called when enumeration of the document has finished. More...
 
virtual Aspose::Words::VisitorAction VisitSectionStart (System::SharedPtr< Aspose::Words::Section > section)
 Called when enumeration of a section has started. More...
 
virtual Aspose::Words::VisitorAction VisitSectionEnd (System::SharedPtr< Aspose::Words::Section > section)
 Called when enumeration of a section has ended. More...
 
virtual Aspose::Words::VisitorAction VisitBodyStart (System::SharedPtr< Aspose::Words::Body > body)
 Called when enumeration of the main text story in a section has started. More...
 
virtual Aspose::Words::VisitorAction VisitBodyEnd (System::SharedPtr< Aspose::Words::Body > body)
 Called when enumeration of the main text story in a section has ended. More...
 
virtual Aspose::Words::VisitorAction VisitHeaderFooterStart (System::SharedPtr< Aspose::Words::HeaderFooter > headerFooter)
 Called when enumeration of a header or footer in a section has started. More...
 
virtual Aspose::Words::VisitorAction VisitHeaderFooterEnd (System::SharedPtr< Aspose::Words::HeaderFooter > headerFooter)
 Called when enumeration of a header or footer in a section has ended. More...
 
virtual Aspose::Words::VisitorAction VisitParagraphStart (System::SharedPtr< Aspose::Words::Paragraph > paragraph)
 Called when enumeration of a paragraph has started. More...
 
virtual Aspose::Words::VisitorAction VisitParagraphEnd (System::SharedPtr< Aspose::Words::Paragraph > paragraph)
 Called when enumeration of a paragraph has ended. More...
 
virtual Aspose::Words::VisitorAction VisitTableStart (System::SharedPtr< Aspose::Words::Tables::Table > table)
 Called when enumeration of a table has started. More...
 
virtual Aspose::Words::VisitorAction VisitTableEnd (System::SharedPtr< Aspose::Words::Tables::Table > table)
 Called when enumeration of a table has ended. More...
 
virtual Aspose::Words::VisitorAction VisitRowStart (System::SharedPtr< Aspose::Words::Tables::Row > row)
 Called when enumeration of a table row has started. More...
 
virtual Aspose::Words::VisitorAction VisitRowEnd (System::SharedPtr< Aspose::Words::Tables::Row > row)
 Called when enumeration of a table row has ended. More...
 
virtual Aspose::Words::VisitorAction VisitCellStart (System::SharedPtr< Aspose::Words::Tables::Cell > cell)
 Called when enumeration of a table cell has started. More...
 
virtual Aspose::Words::VisitorAction VisitCellEnd (System::SharedPtr< Aspose::Words::Tables::Cell > cell)
 Called when enumeration of a table cell has ended. More...
 
virtual Aspose::Words::VisitorAction VisitRun (System::SharedPtr< Aspose::Words::Run > run)
 Called when a run of text in the is encountered. More...
 
virtual Aspose::Words::VisitorAction VisitFieldStart (System::SharedPtr< Aspose::Words::Fields::FieldStart > fieldStart)
 Called when a field starts in the document. More...
 
virtual Aspose::Words::VisitorAction VisitFieldSeparator (System::SharedPtr< Aspose::Words::Fields::FieldSeparator > fieldSeparator)
 Called when a field separator is encountered in the document. More...
 
virtual Aspose::Words::VisitorAction VisitFieldEnd (System::SharedPtr< Aspose::Words::Fields::FieldEnd > fieldEnd)
 Called when a field ends in the document. More...
 
virtual Aspose::Words::VisitorAction VisitFormField (System::SharedPtr< Aspose::Words::Fields::FormField > formField)
 Called when a form field is encountered in the document. More...
 
virtual Aspose::Words::VisitorAction VisitBookmarkStart (System::SharedPtr< Aspose::Words::BookmarkStart > bookmarkStart)
 Called when a start of a bookmark is encountered in the document. More...
 
virtual Aspose::Words::VisitorAction VisitBookmarkEnd (System::SharedPtr< Aspose::Words::BookmarkEnd > bookmarkEnd)
 Called when an end of a bookmark is encountered in the document. More...
 
virtual Aspose::Words::VisitorAction VisitFootnoteStart (System::SharedPtr< Aspose::Words::Footnote > footnote)
 Called when enumeration of a footnote or endnote text has started. More...
 
virtual Aspose::Words::VisitorAction VisitFootnoteEnd (System::SharedPtr< Aspose::Words::Footnote > footnote)
 Called when enumeration of a footnote or endnote text has ended. More...
 
virtual Aspose::Words::VisitorAction VisitCommentStart (System::SharedPtr< Aspose::Words::Comment > comment)
 Called when enumeration of a comment text has started. More...
 
virtual Aspose::Words::VisitorAction VisitCommentEnd (System::SharedPtr< Aspose::Words::Comment > comment)
 Called when enumeration of a comment text has ended. More...
 
virtual Aspose::Words::VisitorAction VisitEditableRangeStart (System::SharedPtr< Aspose::Words::EditableRangeStart > editableRangeStart)
 Called when a start of an editable range is encountered in the document. More...
 
virtual Aspose::Words::VisitorAction VisitEditableRangeEnd (System::SharedPtr< Aspose::Words::EditableRangeEnd > editableRangeEnd)
 Called when an end of an editable range is encountered in the document. More...
 
virtual Aspose::Words::VisitorAction VisitShapeStart (System::SharedPtr< Aspose::Words::Drawing::Shape > shape)
 Called when enumeration of a shape has started. More...
 
virtual Aspose::Words::VisitorAction VisitShapeEnd (System::SharedPtr< Aspose::Words::Drawing::Shape > shape)
 Called when enumeration of a shape has ended. More...
 
virtual Aspose::Words::VisitorAction VisitGroupShapeStart (System::SharedPtr< Aspose::Words::Drawing::GroupShape > groupShape)
 Called when enumeration of a group shape has started. More...
 
virtual Aspose::Words::VisitorAction VisitGroupShapeEnd (System::SharedPtr< Aspose::Words::Drawing::GroupShape > groupShape)
 Called when enumeration of a group shape has ended. More...
 
virtual Aspose::Words::VisitorAction VisitOfficeMathStart (System::SharedPtr< Aspose::Words::Math::OfficeMath > officeMath)
 Called when enumeration of a Office Math object has started. More...
 
virtual Aspose::Words::VisitorAction VisitOfficeMathEnd (System::SharedPtr< Aspose::Words::Math::OfficeMath > officeMath)
 Called when enumeration of a Office Math object has ended. More...
 
virtual Aspose::Words::VisitorAction VisitSpecialChar (System::SharedPtr< Aspose::Words::SpecialChar > specialChar)
 Called when a Aspose::Words::SpecialChar node is encountered in the document. More...
 
virtual Aspose::Words::VisitorAction VisitAbsolutePositionTab (System::SharedPtr< Aspose::Words::AbsolutePositionTab > tab)
 Called when a Aspose::Words::AbsolutePositionTab node is encountered in the document. More...
 
virtual Aspose::Words::VisitorAction VisitSmartTagStart (System::SharedPtr< Aspose::Words::Markup::SmartTag > smartTag)
 Called when enumeration of a smart tag has started. More...
 
virtual Aspose::Words::VisitorAction VisitSmartTagEnd (System::SharedPtr< Aspose::Words::Markup::SmartTag > smartTag)
 Called when enumeration of a smart tag has ended. More...
 
virtual Aspose::Words::VisitorAction VisitStructuredDocumentTagStart (System::SharedPtr< Aspose::Words::Markup::StructuredDocumentTag > sdt)
 Called when enumeration of a structured document tag has started. More...
 
virtual Aspose::Words::VisitorAction VisitStructuredDocumentTagEnd (System::SharedPtr< Aspose::Words::Markup::StructuredDocumentTag > sdt)
 Called when enumeration of a structured document tag has ended. More...
 
virtual Aspose::Words::VisitorAction VisitGlossaryDocumentStart (System::SharedPtr< Aspose::Words::BuildingBlocks::GlossaryDocument > glossary)
 Called when enumeration of a glossary document has started. More...
 
virtual Aspose::Words::VisitorAction VisitGlossaryDocumentEnd (System::SharedPtr< Aspose::Words::BuildingBlocks::GlossaryDocument > glossary)
 Called when enumeration of a glossary document has ended. More...
 
virtual Aspose::Words::VisitorAction VisitBuildingBlockStart (System::SharedPtr< Aspose::Words::BuildingBlocks::BuildingBlock > block)
 Called when enumeration of a building block has started. More...
 
virtual Aspose::Words::VisitorAction VisitBuildingBlockEnd (System::SharedPtr< Aspose::Words::BuildingBlocks::BuildingBlock > block)
 Called when enumeration of a building block has ended. More...
 
virtual Aspose::Words::VisitorAction VisitCommentRangeStart (System::SharedPtr< Aspose::Words::CommentRangeStart > commentRangeStart)
 Called when the start of a commented range of text is encountered. More...
 
virtual Aspose::Words::VisitorAction VisitCommentRangeEnd (System::SharedPtr< Aspose::Words::CommentRangeEnd > commentRangeEnd)
 Called when the end of a commented range of text is encountered. More...
 
virtual Aspose::Words::VisitorAction VisitSubDocument (System::SharedPtr< Aspose::Words::SubDocument > subDocument)
 Called when a subDocument is encountered. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Base class for custom document visitors.

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 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.

Member Function Documentation

◆ VisitAbsolutePositionTab()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitAbsolutePositionTab ( System::SharedPtr< Aspose::Words::AbsolutePositionTab tab)
virtual

Called when a Aspose::Words::AbsolutePositionTab node is encountered in the document.

Parameters
tabThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitBodyEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitBodyEnd ( System::SharedPtr< Aspose::Words::Body body)
virtual

Called when enumeration of the main text story in a section has ended.

Parameters
bodyThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitBodyStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitBodyStart ( System::SharedPtr< Aspose::Words::Body body)
virtual

Called when enumeration of the main text story in a section has started.

Parameters
bodyThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitBookmarkEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitBookmarkEnd ( System::SharedPtr< Aspose::Words::BookmarkEnd bookmarkEnd)
virtual

Called when an end of a bookmark is encountered in the document.

Parameters
bookmarkEndThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitBookmarkStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitBookmarkStart ( System::SharedPtr< Aspose::Words::BookmarkStart bookmarkStart)
virtual

Called when a start of a bookmark is encountered in the document.

Parameters
bookmarkStartThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitBuildingBlockEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitBuildingBlockEnd ( System::SharedPtr< Aspose::Words::BuildingBlocks::BuildingBlock block)
virtual

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 Aspose::Words::Document. If you want to execute a Visitor over a building block, you need to execute the visitor over Aspose::Words::BuildingBlocks::GlossaryDocument or call Aspose::Words::BuildingBlocks::BuildingBlock::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>).

Parameters
blockThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitBuildingBlockStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitBuildingBlockStart ( System::SharedPtr< Aspose::Words::BuildingBlocks::BuildingBlock block)
virtual

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 Aspose::Words::Document. If you want to execute a Visitor over a building block, you need to execute the visitor over Aspose::Words::BuildingBlocks::GlossaryDocument or call Aspose::Words::BuildingBlocks::BuildingBlock::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>).

Parameters
blockThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitCellEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitCellEnd ( System::SharedPtr< Aspose::Words::Tables::Cell cell)
virtual

Called when enumeration of a table cell has ended.

Parameters
cellThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitCellStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitCellStart ( System::SharedPtr< Aspose::Words::Tables::Cell cell)
virtual

Called when enumeration of a table cell has started.

Parameters
cellThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitCommentEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitCommentEnd ( System::SharedPtr< Aspose::Words::Comment comment)
virtual

Called when enumeration of a comment text has ended.

Parameters
commentThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitCommentRangeEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitCommentRangeEnd ( System::SharedPtr< Aspose::Words::CommentRangeEnd commentRangeEnd)
virtual

Called when the end of a commented range of text is encountered.

Parameters
commentRangeEndThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitCommentRangeStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitCommentRangeStart ( System::SharedPtr< Aspose::Words::CommentRangeStart commentRangeStart)
virtual

Called when the start of a commented range of text is encountered.

Parameters
commentRangeStartThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitCommentStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitCommentStart ( System::SharedPtr< Aspose::Words::Comment comment)
virtual

Called when enumeration of a comment text has started.

Parameters
commentThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitDocumentEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitDocumentEnd ( System::SharedPtr< Aspose::Words::Document doc)
virtual

Called when enumeration of the document has finished.

Parameters
docThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitDocumentStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitDocumentStart ( System::SharedPtr< Aspose::Words::Document doc)
virtual

Called when enumeration of the document has started.

Parameters
docThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitEditableRangeEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitEditableRangeEnd ( System::SharedPtr< Aspose::Words::EditableRangeEnd editableRangeEnd)
virtual

Called when an end of an editable range is encountered in the document.

Parameters
editableRangeEndThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitEditableRangeStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitEditableRangeStart ( System::SharedPtr< Aspose::Words::EditableRangeStart editableRangeStart)
virtual

Called when a start of an editable range is encountered in the document.

Parameters
editableRangeStartThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitFieldEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitFieldEnd ( System::SharedPtr< Aspose::Words::Fields::FieldEnd fieldEnd)
virtual

Called when a field ends in the document.

For more info see Aspose::Words::DocumentVisitor::VisitFieldStart(System::SharedPtr<Aspose::Words::Fields::FieldStart>)

Parameters
fieldEndThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitFieldSeparator()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitFieldSeparator ( System::SharedPtr< Aspose::Words::Fields::FieldSeparator fieldSeparator)
virtual

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 Aspose::Words::DocumentVisitor::VisitFieldStart(System::SharedPtr<Aspose::Words::Fields::FieldStart>)

Parameters
fieldSeparatorThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitFieldStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitFieldStart ( System::SharedPtr< Aspose::Words::Fields::FieldStart fieldStart)
virtual

Called when a field starts in the document.

A field in a Word 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
fieldStartThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitFootnoteEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitFootnoteEnd ( System::SharedPtr< Aspose::Words::Footnote footnote)
virtual

Called when enumeration of a footnote or endnote text has ended.

Parameters
footnoteThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitFootnoteStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitFootnoteStart ( System::SharedPtr< Aspose::Words::Footnote footnote)
virtual

Called when enumeration of a footnote or endnote text has started.

Parameters
footnoteThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitFormField()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitFormField ( System::SharedPtr< Aspose::Words::Fields::FormField formField)
virtual

Called when a form field is encountered in the document.

Parameters
formFieldThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitGlossaryDocumentEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitGlossaryDocumentEnd ( System::SharedPtr< Aspose::Words::BuildingBlocks::GlossaryDocument glossary)
virtual

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 Aspose::Words::Document. If you want to execute a Visitor over a glossary document, you need to call Aspose::Words::BuildingBlocks::GlossaryDocument::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>).

Parameters
glossaryThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitGlossaryDocumentStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitGlossaryDocumentStart ( System::SharedPtr< Aspose::Words::BuildingBlocks::GlossaryDocument glossary)
virtual

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 Aspose::Words::Document. If you want to execute a Visitor over a glossary document, you need to call Aspose::Words::BuildingBlocks::GlossaryDocument::Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>).

Parameters
glossaryThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitGroupShapeEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitGroupShapeEnd ( System::SharedPtr< Aspose::Words::Drawing::GroupShape groupShape)
virtual

Called when enumeration of a group shape has ended.

Parameters
groupShapeThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitGroupShapeStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitGroupShapeStart ( System::SharedPtr< Aspose::Words::Drawing::GroupShape groupShape)
virtual

Called when enumeration of a group shape has started.

Parameters
groupShapeThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitHeaderFooterEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitHeaderFooterEnd ( System::SharedPtr< Aspose::Words::HeaderFooter headerFooter)
virtual

Called when enumeration of a header or footer in a section has ended.

Parameters
headerFooterThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitHeaderFooterStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitHeaderFooterStart ( System::SharedPtr< Aspose::Words::HeaderFooter headerFooter)
virtual

Called when enumeration of a header or footer in a section has started.

Parameters
headerFooterThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitOfficeMathEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitOfficeMathEnd ( System::SharedPtr< Aspose::Words::Math::OfficeMath officeMath)
virtual

Called when enumeration of a Office Math object has ended.

Parameters
officeMathThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitOfficeMathStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitOfficeMathStart ( System::SharedPtr< Aspose::Words::Math::OfficeMath officeMath)
virtual

Called when enumeration of a Office Math object has started.

Parameters
officeMathThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitParagraphEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitParagraphEnd ( System::SharedPtr< Aspose::Words::Paragraph paragraph)
virtual

Called when enumeration of a paragraph has ended.

Parameters
paragraphThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitParagraphStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitParagraphStart ( System::SharedPtr< Aspose::Words::Paragraph paragraph)
virtual

Called when enumeration of a paragraph has started.

Parameters
paragraphThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitRowEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitRowEnd ( System::SharedPtr< Aspose::Words::Tables::Row row)
virtual

Called when enumeration of a table row has ended.

Parameters
rowThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitRowStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitRowStart ( System::SharedPtr< Aspose::Words::Tables::Row row)
virtual

Called when enumeration of a table row has started.

Parameters
rowThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitRun()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitRun ( System::SharedPtr< Aspose::Words::Run run)
virtual

Called when a run of text in the is encountered.

Parameters
runThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitSectionEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitSectionEnd ( System::SharedPtr< Aspose::Words::Section section)
virtual

Called when enumeration of a section has ended.

Parameters
sectionThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitSectionStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitSectionStart ( System::SharedPtr< Aspose::Words::Section section)
virtual

Called when enumeration of a section has started.

Parameters
sectionThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitShapeEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitShapeEnd ( System::SharedPtr< Aspose::Words::Drawing::Shape shape)
virtual

Called when enumeration of a shape has ended.

Parameters
shapeThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitShapeStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitShapeStart ( System::SharedPtr< Aspose::Words::Drawing::Shape shape)
virtual

Called when enumeration of a shape has started.

Parameters
shapeThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitSmartTagEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitSmartTagEnd ( System::SharedPtr< Aspose::Words::Markup::SmartTag smartTag)
virtual

Called when enumeration of a smart tag has ended.

Parameters
smartTagThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitSmartTagStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitSmartTagStart ( System::SharedPtr< Aspose::Words::Markup::SmartTag smartTag)
virtual

Called when enumeration of a smart tag has started.

Parameters
smartTagThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitSpecialChar()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitSpecialChar ( System::SharedPtr< Aspose::Words::SpecialChar specialChar)
virtual

Called when a Aspose::Words::SpecialChar node is encountered in the document.

Parameters
specialCharThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

This method is not be called for generic control characters (see Aspose::Words::ControlChar) that can be present in the document.

◆ VisitStructuredDocumentTagEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitStructuredDocumentTagEnd ( System::SharedPtr< Aspose::Words::Markup::StructuredDocumentTag sdt)
virtual

Called when enumeration of a structured document tag has ended.

Parameters
sdtThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitStructuredDocumentTagStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitStructuredDocumentTagStart ( System::SharedPtr< Aspose::Words::Markup::StructuredDocumentTag sdt)
virtual

Called when enumeration of a structured document tag has started.

Parameters
sdtThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitSubDocument()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitSubDocument ( System::SharedPtr< Aspose::Words::SubDocument subDocument)
virtual

Called when a subDocument is encountered.

Parameters
subDocumentThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitTableEnd()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitTableEnd ( System::SharedPtr< Aspose::Words::Tables::Table table)
virtual

Called when enumeration of a table has ended.

Parameters
tableThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.

◆ VisitTableStart()

virtual Aspose::Words::VisitorAction Aspose::Words::DocumentVisitor::VisitTableStart ( System::SharedPtr< Aspose::Words::Tables::Table table)
virtual

Called when enumeration of a table has started.

Parameters
tableThe object that is being visited.
Returns
A Aspose::Words::VisitorAction value that specifies how to continue the enumeration.