RichEditControl.ScrollToCaret() Method

Scrolls the document to the caret position.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public void ScrollToCaret()

VB.NET

Public Sub ScrollToCaret

Remarks

This method shows the cursor location to the user. To get the caret position programmatically, use the Document.CaretPosition property.

Example

The following code loads a document and scrolls to its end. The current RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

View Example

RichEditControlActions.cs

static void buttonCustomAction_ItemClick_ScrollToCaretMethod(object sender, ItemClickEventArgs e) {
    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    richEdit.LoadDocument("Documents\\MultiPageDocument.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
    richEdit.Document.CaretPosition = richEdit.Document.Range.End;
    richEdit.ScrollToCaret();
}

RichEditControlActions.vb

Private Shared Sub buttonCustomAction_ItemClick_ScrollToCaretMethod(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
    richEdit.LoadDocument("Documents\MultiPageDocument.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
    richEdit.Document.CaretPosition = richEdit.Document.Range.End
    richEdit.ScrollToCaret()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ScrollToCaret() 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#

winforms-richedit-perform-drag-and-drop-from-list-box/CS/Form1.cs#L57

    richEditGraphics.FillRectangle(Brushes.Blue, rect);
    richEditControl1.ScrollToCaret();
}

winforms-richedit-rich-drag-and-drop-gridview-cell-data/CS/DragDropExample/Form1.cs#L129

richEditGraphics.FillRectangle(Brushes.Black, rect);
richEditControl1.ScrollToCaret();
oldPosition = pos;

winforms-richedit-create-log-viewer-application/CS/Form1.cs#L43

    document.CaretPosition = document.Paragraphs.Get( document.Range.End).Range.Start;
    richEditControl1.ScrollToCaret();
}

winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L101

    richEdit.Document.CaretPosition = richEdit.Document.Range.End;
    richEdit.ScrollToCaret();
}

VB.NET

winforms-richedit-perform-drag-and-drop-from-list-box/VB/Form1.vb#L43

    richEditGraphics.FillRectangle(Brushes.Blue, rect)
    richEditControl1.ScrollToCaret()
End Sub

winforms-richedit-rich-drag-and-drop-gridview-cell-data/VB/DragDropExample/Form1.vb#L107

richEditGraphics.FillRectangle(Brushes.Black, rect)
richEditControl1.ScrollToCaret()
oldPosition = pos

winforms-richedit-create-log-viewer-application/VB/Form1.vb#L42

    document.CaretPosition = document.Paragraphs.Get(document.Range.End).Range.Start
    richEditControl1.ScrollToCaret()
End Sub

winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L106

    richEdit.Document.CaretPosition = richEdit.Document.Range.End
    richEdit.ScrollToCaret()
End Sub