Skip to main content

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

public void 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

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();
}

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.

See Also