DocumentVisitorBase Class

A base class implementing the IDocumentVisitor interface.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public abstract class DocumentVisitorBase :
    IDocumentVisitor

VB.NET

Public MustInherit Class DocumentVisitorBase
    Implements IDocumentVisitor

Remarks

Use the DocumentVisitorBase instead of your custom implementation to keep up with the actual state of the IDocumentVisitor interface in the event of possible modifications in the future.

Example

MyVisitor is a DocumentVisitorBase class descendant which provides a method that processes DocumentText elements to do the following.

• Enclose the bold text in asterisks
• Return all characters without formatting
• Replace the paragraph ends with newline symbols

Other document elements are skipped.

View Example

Form1.cs

public class MyVisitor : DocumentVisitorBase
{
    readonly StringBuilder buffer;
    public MyVisitor() { this.buffer = new StringBuilder(); }
    protected StringBuilder Buffer { get { return buffer; } }
    public string Text { get { return Buffer.ToString(); } }

    public override void Visit(DocumentText text) {
        string prefix = (text.TextProperties.FontBold) ? "**" : "";
        Buffer.Append(prefix);
        Buffer.Append(text.Text);
        Buffer.Append(prefix);
    }
    public override void Visit(DocumentParagraphEnd paragraphEnd) {
        Buffer.AppendLine();
    }
}

Form1.vb

Public Class MyVisitor
    Inherits DocumentVisitorBase


    Private ReadOnly buffer_Renamed As StringBuilder
    Public Sub New()
        Me.buffer_Renamed = New StringBuilder()
    End Sub
    Protected ReadOnly Property Buffer() As StringBuilder
        Get
            Return buffer_Renamed
        End Get
    End Property
    Public ReadOnly Property Text() As String
        Get
            Return ToString()
        End Get
    End Property

    Public Overrides Sub Visit(ByVal text As DocumentText)
        Dim prefix As String = If(text.TextProperties.FontBold, "**", "")
        Buffer.Append(prefix)
        Buffer.Append(text.Text)
        Buffer.Append(prefix)
    End Sub
    Public Overrides Sub Visit(ByVal paragraphEnd As DocumentParagraphEnd)
        Buffer.AppendLine()
    End Sub
End Class

Implements

IDocumentVisitor

Inheritance

Object

DocumentVisitorBase