LayoutVisitor.Visit(LayoutElement) Method

Dispatches the specified layout element to a special method of the Visitor class.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

Declaration

C#

public virtual void Visit(
    LayoutElement element
)

VB.NET

Public Overridable Sub Visit(
    element As LayoutElement
)

Parameters

Name	Type	Description
element	LayoutElement	A LayoutElement descendant that is the element for which a specialized method is called.

Remarks

Call this method to traverse the layout tree starting with the specified node.

The Visit method calls the Accept method of the specified layout element which, in turn, calls the specialized method of the visitor instance. For example, the LayoutVisitor.Visit(LayoutPageArea) calls the LayoutPageArea.Accept method which, in turn, calls the VisitPageArea method which should be overridden in the LayoutVisitor custom descendant.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/layout-api-simple-example-t245818

Form1.vb

Private Sub DocumentLayout_DocumentFormatted(ByVal sender As Object, ByVal e As EventArgs)

    richEditControl1.BeginInvoke(New Action(Sub()
        Dim pageCount As Integer = richEditControl1.DocumentLayout.GetFormattedPageCount()
        For i As Integer = 0 To pageCount - 1
            Dim visitor As New MyDocumentLayoutVisitor()
            visitor.Visit(richEditControl1.DocumentLayout.GetPage(i))
        Next i
    End Sub))
End Sub

Form1.cs

private void DocumentLayout_DocumentFormatted(object sender, EventArgs e)
{

    richEditControl1.BeginInvoke(new Action(() =>
    {
        int pageCount = richEditControl1.DocumentLayout.GetFormattedPageCount();
        for (int i = 0; i < pageCount; i++)
        {
            MyDocumentLayoutVisitor visitor = new MyDocumentLayoutVisitor();
            visitor.Visit(richEditControl1.DocumentLayout.GetPage(i));
        }
    }));
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Visit(LayoutElement) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

layout-api-simple-example-t245818/CS/LayoutApiSimpleExample/Form1.cs#L29

    MyDocumentLayoutVisitor visitor = new MyDocumentLayoutVisitor();
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(i));
}

layout-api-treeview-example-t239200/CS/LayoutApiSample/Form1.cs#L121

// Traverse the document layout tree.
collector.Visit(richEditControl1.DocumentLayout.GetPage(i));
// Create a tree node / layout element dictionary for later use.

document-layout-api-practical-usage-t266080/CS/WindowsFormsApplication1/DocumentLayoutHelper/TextBoxLayoutHelper.cs#L52

CustomDocumentLayoutVisitor visitor = new CustomDocumentLayoutVisitor();
visitor.Visit(currentTextBox);

how-to-emulate-the-ms-word-information-status-bar-when-using-richeditcontrol-t467150/CS/WindowsFormsApplication1/Form1.cs#L41

    visitor.Reset();
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(list[i].PageIndex));
}

how-to-enable-line-numbering-and-count-the-document-rows-t531470/CS/LineNumberingExample/Form1.cs#L78

for (int i = 0; i < pageCount; i++) {
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(i));
}

VB.NET

how-to-emulate-the-ms-word-information-status-bar-when-using-richeditcontrol-t467150/VB/WindowsFormsApplication1/Form1.vb#L34

    visitor.Reset()
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(list(i).PageIndex))
Next i

layout-api-simple-example-t245818/VB/LayoutApiSimpleExample/Form1.vb#L25

    Dim visitor As New MyDocumentLayoutVisitor()
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(i))
Next i

layout-api-treeview-example-t239200/VB/LayoutApiSample/Form1.vb#L117

Dim collector As New TreeViewCollector(treeView1, richEditControl1)
collector.Visit(richEditControl1.DocumentLayout.GetPage(i))
collector.Dictionary.ToList().ForEach(Sub(x) layoutTreeDictionary.Add(x.Value, x.Key))

document-layout-api-practical-usage-t266080/VB/WindowsFormsApplication1/DocumentLayoutHelper/TextBoxLayoutHelper.vb#L57

Dim visitor As New CustomDocumentLayoutVisitor()
visitor.Visit(currentTextBox)

how-to-enable-line-numbering-and-count-the-document-rows-t531470/VB/LineNumberingExample/Form1.vb#L79

For i As Integer = 0 To pageCount - 1
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(i))
Next i