Class DocumentVisitor
Namespace: Aspose.Note
Assembly: Aspose.Note.dll (24.12.0)
The abstract class for iterating through subtree with root at the specified node.
public abstract class DocumentVisitorInheritance
Inherited Members
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Examples
Shows how to access content of a document using visitor.```csharp public static void Run() { // The path to the documents directory. string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// Open the document we want to convert.
Document doc = new Document(dataDir + "Aspose.one");
// Create an object that inherits from the DocumentVisitor class.
MyOneNoteToTxtWriter myConverter = new MyOneNoteToTxtWriter();
// This is the well known Visitor pattern. Get the model to accept a visitor.
// The model will iterate through itself by calling the corresponding methods
// on the visitor object (this is called visiting).
//
// Note that every node in the object model has the Accept method so the visiting
// can be executed not only for the whole document, but for any node in the document.
doc.Accept(myConverter);
// Once the visiting is complete, we can retrieve the result of the operation,
// that in this example, has accumulated in the visitor.
Console.WriteLine(myConverter.GetText());
Console.WriteLine(myConverter.NodeCount);
}
/// <summary>
/// Simple implementation of saving a document in the plain text format. Implemented as a Visitor.
/// </summary>
public class MyOneNoteToTxtWriter : DocumentVisitor
{
public MyOneNoteToTxtWriter()
{
nodecount = 0;
mIsSkipText = false;
mBuilder = new StringBuilder();
}
/// <summary>
/// Gets the plain text of the document that was accumulated by the visitor.
/// </summary>
public string GetText()
{
return mBuilder.ToString();
}
/// <summary>
/// Adds text to the current output. Honors the enabled/disabled output flag.
/// </summary>
private void AppendText(string text)
{
if (!mIsSkipText)
{
mBuilder.AppendLine(text);
}
}
/// <summary>
/// Called when a RichText node is encountered in the document.
/// </summary>
public override void VisitRichTextStart(RichText run)
{
++nodecount;
AppendText(run.Text);
}
/// <summary>
/// Called when a Document node is encountered in the document.
/// </summary>
public override void VisitDocumentStart(Document document)
{
++nodecount;
}
/// <summary>
/// Called when a Page node is encountered in the document.
/// </summary>
public override void VisitPageStart(Page page)
{
++nodecount;
this.AppendText($"*** Page '{page.Title?.TitleText?.Text ?? "(no title)"}' ***");
}
/// <summary>
/// Called when processing of a Page node is finished.
/// </summary>
public override void VisitPageEnd(Page page)
{
this.AppendText(string.Empty);
}
/// <summary>
/// Called when a Title node is encountered in the document.
/// </summary>
public override void VisitTitleStart(Title title)
{
++nodecount;
}
/// <summary>
/// Called when a Image node is encountered in the document.
/// </summary>
public override void VisitImageStart(Image image)
{
++nodecount;
}
/// <summary>
/// Called when a OutlineGroup node is encountered in the document.
/// </summary>
public override void VisitOutlineGroupStart(OutlineGroup outlineGroup)
{
++nodecount;
}
/// <summary>
/// Called when a Outline node is encountered in the document.
/// </summary>
public override void VisitOutlineStart(Outline outline)
{
++nodecount;
}
/// <summary>
/// Called when a OutlineElement node is encountered in the document.
/// </summary>
public override void VisitOutlineElementStart(OutlineElement outlineElement)
{
++nodecount;
}
/// <summary>
/// Gets the total count of nodes by the Visitor
/// </summary>
public Int32 NodeCount
{
get { return this.nodecount; }
}
private readonly StringBuilder mBuilder;
private bool mIsSkipText;
private Int32 nodecount;
}
## Constructors
### <a id="Aspose_Note_DocumentVisitor__ctor"></a> DocumentVisitor\(\)
```csharp
protected DocumentVisitor()Methods
VisitAttachedFileEnd(AttachedFile)
End to visit the Aspose.Note.AttachedFile node.
public virtual void VisitAttachedFileEnd(AttachedFile attachedFile)Parameters
attachedFile AttachedFile
The Aspose.Note.AttachedFile node.
VisitAttachedFileStart(AttachedFile)
Start to visit the Aspose.Note.AttachedFile node.
public virtual void VisitAttachedFileStart(AttachedFile attachedFile)Parameters
attachedFile AttachedFile
The Aspose.Note.AttachedFile node.
VisitDocumentEnd(Document)
End to visit the Aspose.Note.Document node.
public virtual void VisitDocumentEnd(Document document)Parameters
document Document
The Aspose.Note.Document node.
VisitDocumentStart(Document)
Start to visit the Aspose.Note.Document node.
public virtual void VisitDocumentStart(Document document)Parameters
document Document
The Aspose.Note.Document node.
VisitImageEnd(Image)
End to visit the Aspose.Note.Image node.
public virtual void VisitImageEnd(Image image)Parameters
image Image
The Aspose.Note.Image node.
VisitImageStart(Image)
Start to visit the Aspose.Note.Image node.
public virtual void VisitImageStart(Image image)Parameters
image Image
The Aspose.Note.Image node.
VisitInkDrawingEnd(InkDrawing)
End to visit the Aspose.Note.InkDrawing node.
public virtual void VisitInkDrawingEnd(InkDrawing inkDrawing)Parameters
inkDrawing InkDrawing
The Aspose.Note.InkDrawing node.
VisitInkDrawingStart(InkDrawing)
Start to visit the Aspose.Note.InkDrawing node.
public virtual void VisitInkDrawingStart(InkDrawing inkDrawing)Parameters
inkDrawing InkDrawing
The Aspose.Note.InkDrawing node.
VisitInkParagraphEnd(InkParagraph)
End to visit the Aspose.Note.InkParagraph node.
public virtual void VisitInkParagraphEnd(InkParagraph inkParagraph)Parameters
inkParagraph InkParagraph
The Aspose.Note.InkParagraph node.
VisitInkParagraphStart(InkParagraph)
Start to visit the Aspose.Note.InkParagraph node.
public virtual void VisitInkParagraphStart(InkParagraph inkParagraph)Parameters
inkParagraph InkParagraph
The Aspose.Note.InkParagraph node.
VisitInkWordEnd(InkWord)
End to visit the Aspose.Note.InkWord node.
public virtual void VisitInkWordEnd(InkWord inkWord)Parameters
inkWord InkWord
The Aspose.Note.InkWord node.
VisitInkWordStart(InkWord)
Start to visit the Aspose.Note.InkWord node.
public virtual void VisitInkWordStart(InkWord inkWord)Parameters
inkWord InkWord
The Aspose.Note.InkWord node.
VisitOutlineElementEnd(OutlineElement)
End to visit the Aspose.Note.OutlineElement node.
public virtual void VisitOutlineElementEnd(OutlineElement outlineElement)Parameters
outlineElement OutlineElement
The Aspose.Note.OutlineElement node.
VisitOutlineElementStart(OutlineElement)
Start to visit the Aspose.Note.OutlineElement node.
public virtual void VisitOutlineElementStart(OutlineElement outlineElement)Parameters
outlineElement OutlineElement
The Aspose.Note.OutlineElement node.
VisitOutlineEnd(Outline)
End to visit the Aspose.Note.Outline node.
public virtual void VisitOutlineEnd(Outline outline)Parameters
outline Outline
The Aspose.Note.Outline node.
VisitOutlineGroupEnd(OutlineGroup)
End to visit the Aspose.Note.OutlineGroup node.
public virtual void VisitOutlineGroupEnd(OutlineGroup outlineGroup)Parameters
outlineGroup OutlineGroup
The Aspose.Note.OutlineGroup node.
VisitOutlineGroupStart(OutlineGroup)
Start to visit the Aspose.Note.OutlineGroup node.
public virtual void VisitOutlineGroupStart(OutlineGroup outlineGroup)Parameters
outlineGroup OutlineGroup
The Aspose.Note.OutlineGroup node.
VisitOutlineStart(Outline)
Start to visit the Aspose.Note.Outline node.
public virtual void VisitOutlineStart(Outline outline)Parameters
outline Outline
The Aspose.Note.Outline node.
VisitPageEnd(Page)
End to visit the Aspose.Note.Page node.
public virtual void VisitPageEnd(Page page)Parameters
page Page
The Aspose.Note.Page node.
VisitPageStart(Page)
Start to visit the Aspose.Note.Page node.
public virtual void VisitPageStart(Page page)Parameters
page Page
The Aspose.Note.Page node.
VisitRichTextEnd(RichText)
End to visit the Aspose.Note.RichText node.
public virtual void VisitRichTextEnd(RichText richText)Parameters
richText RichText
The Aspose.Note.RichText node.
VisitRichTextStart(RichText)
Start to visit the Aspose.Note.RichText node.
public virtual void VisitRichTextStart(RichText richText)Parameters
richText RichText
The Aspose.Note.RichText node.
VisitTableCellEnd(TableCell)
End to visit the Aspose.Note.TableCell node.
public virtual void VisitTableCellEnd(TableCell tableCell)Parameters
tableCell TableCell
The Aspose.Note.TableCell node.
VisitTableCellStart(TableCell)
Start to visit the Aspose.Note.TableCell node.
public virtual void VisitTableCellStart(TableCell tableCell)Parameters
tableCell TableCell
The Aspose.Note.TableCell node.
VisitTableEnd(Table)
End to visit the Aspose.Note.Table node.
public virtual void VisitTableEnd(Table table)Parameters
table Table
The Aspose.Note.Table node.
VisitTableRowEnd(TableRow)
End to visit the Aspose.Note.TableRow node.
public virtual void VisitTableRowEnd(TableRow tableRow)Parameters
tableRow TableRow
The Aspose.Note.TableRow node.
VisitTableRowStart(TableRow)
Start to visit the Aspose.Note.TableRow node.
public virtual void VisitTableRowStart(TableRow tableRow)Parameters
tableRow TableRow
The Aspose.Note.TableRow node.
VisitTableStart(Table)
Start to visit the Aspose.Note.Table node.
public virtual void VisitTableStart(Table table)Parameters
table Table
The Aspose.Note.Table node.
VisitTitleEnd(Title)
End to visit the Aspose.Note.Title node.
public virtual void VisitTitleEnd(Title title)Parameters
title Title
The Aspose.Note.Title node.
VisitTitleStart(Title)
Start to visit the Aspose.Note.Title node.
public virtual void VisitTitleStart(Title title)Parameters
title Title
The Aspose.Note.Title node.