RichEditControl.ScrollToCaret(Single) Method

Scrolls the document so that the caret position is displayed at the specified relative vertical offset.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

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

Declaration

C#

public void ScrollToCaret(
    float relativeVerticalPosition
)

VB.NET

Public Sub ScrollToCaret(
    relativeVerticalPosition As Single
)

Parameters

Name	Type	Description
relativeVerticalPosition	Single	A number specifying the relative vertical offset. Must be within the range 0.0 - 1.0

Remarks

The ScrollToCaret method allows you to scroll the document to display the caret position at the specified relative offset from the top of the control. An offset equal to zero means that the row containing caret will be the first visible row in the document; offset value 1.0 specifies that the mentioned row will be the last visible row.

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