• DR-IT Software
  • Products
  • Documentation
  • Product page
  • Examples
  • API reference
  • Support
Show / Hide Table of Contents

Class DocumentVisitor

Provides callbacks for traversing a document node tree.

Inheritance
object
DocumentVisitor
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: DRIT.Document
Assembly: DRIT.Document.dll
Syntax
public abstract class DocumentVisitor

Methods

Visit(Node)

Called for a node without a more specific callback.

Declaration
public virtual VisitorAction Visit(Node node)
Parameters
Type Name Description
Node node

The node being visited.

Returns
Type Description
VisitorAction

The action controlling traversal.

VisitBodyEnd(Body)

Called after visiting a body story's children.

Declaration
public virtual VisitorAction VisitBodyEnd(Body body)
Parameters
Type Name Description
Body body
Returns
Type Description
VisitorAction

VisitBodyStart(Body)

Called before visiting a body story's children.

Declaration
public virtual VisitorAction VisitBodyStart(Body body)
Parameters
Type Name Description
Body body
Returns
Type Description
VisitorAction

VisitCellEnd(Cell)

Called after visiting a cell's content.

Declaration
public virtual VisitorAction VisitCellEnd(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
VisitorAction

VisitCellStart(Cell)

Called before visiting a cell's content.

Declaration
public virtual VisitorAction VisitCellStart(Cell cell)
Parameters
Type Name Description
Cell cell
Returns
Type Description
VisitorAction

VisitDocumentEnd(Document)

Called after visiting the document's children.

Declaration
public virtual VisitorAction VisitDocumentEnd(Document document)
Parameters
Type Name Description
Document document
Returns
Type Description
VisitorAction

VisitDocumentStart(Document)

Called before visiting the document's children.

Declaration
public virtual VisitorAction VisitDocumentStart(Document document)
Parameters
Type Name Description
Document document
Returns
Type Description
VisitorAction

VisitHeaderFooterEnd(HeaderFooter)

Called after visiting a header or footer's children.

Declaration
public virtual VisitorAction VisitHeaderFooterEnd(HeaderFooter headerFooter)
Parameters
Type Name Description
HeaderFooter headerFooter
Returns
Type Description
VisitorAction

VisitHeaderFooterStart(HeaderFooter)

Called before visiting a header or footer's children.

Declaration
public virtual VisitorAction VisitHeaderFooterStart(HeaderFooter headerFooter)
Parameters
Type Name Description
HeaderFooter headerFooter
Returns
Type Description
VisitorAction

VisitNode(Node)

Called for a node without a more specific callback.

Declaration
public virtual VisitorAction VisitNode(Node node)
Parameters
Type Name Description
Node node
Returns
Type Description
VisitorAction

VisitParagraphEnd(Paragraph)

Called after visiting a paragraph's inline nodes.

Declaration
public virtual VisitorAction VisitParagraphEnd(Paragraph paragraph)
Parameters
Type Name Description
Paragraph paragraph
Returns
Type Description
VisitorAction

VisitParagraphStart(Paragraph)

Called before visiting a paragraph's inline nodes.

Declaration
public virtual VisitorAction VisitParagraphStart(Paragraph paragraph)
Parameters
Type Name Description
Paragraph paragraph
Returns
Type Description
VisitorAction

VisitRowEnd(Row)

Called after visiting a row's cells.

Declaration
public virtual VisitorAction VisitRowEnd(Row row)
Parameters
Type Name Description
Row row
Returns
Type Description
VisitorAction

VisitRowStart(Row)

Called before visiting a row's cells.

Declaration
public virtual VisitorAction VisitRowStart(Row row)
Parameters
Type Name Description
Row row
Returns
Type Description
VisitorAction

VisitRun(Run)

Called for each text run.

Declaration
public virtual VisitorAction VisitRun(Run run)
Parameters
Type Name Description
Run run
Returns
Type Description
VisitorAction

VisitSectionEnd(Section)

Called after visiting a section's children.

Declaration
public virtual VisitorAction VisitSectionEnd(Section section)
Parameters
Type Name Description
Section section
Returns
Type Description
VisitorAction

VisitSectionStart(Section)

Called before visiting a section's children.

Declaration
public virtual VisitorAction VisitSectionStart(Section section)
Parameters
Type Name Description
Section section
Returns
Type Description
VisitorAction

VisitShapeEnd(DocumentShape)

Called after visiting an inline shape's text story.

Declaration
public virtual VisitorAction VisitShapeEnd(DocumentShape shape)
Parameters
Type Name Description
DocumentShape shape
Returns
Type Description
VisitorAction

VisitShapeStart(DocumentShape)

Called before visiting an inline shape's text story.

Declaration
public virtual VisitorAction VisitShapeStart(DocumentShape shape)
Parameters
Type Name Description
DocumentShape shape
Returns
Type Description
VisitorAction

VisitTableEnd(Table)

Called after visiting a table's rows.

Declaration
public virtual VisitorAction VisitTableEnd(Table table)
Parameters
Type Name Description
Table table
Returns
Type Description
VisitorAction

VisitTableStart(Table)

Called before visiting a table's rows.

Declaration
public virtual VisitorAction VisitTableStart(Table table)
Parameters
Type Name Description
Table table
Returns
Type Description
VisitorAction
Back to top

DR-IT Software documentation

DR-IT Software · Products · Documentation index · Product page · Downloads · Support · Licensing

Generated by DocFX