ScrollToCaret Method (EditBase)

Scrolls the content of the control to the current caret position.

Syntax

Visual Basic
C#

'Declaration
 
Public Sub ScrollToCaret()

'Usage
 
Dim instance As EditBase
 
instance.ScrollToCaret()

public void ScrollToCaret()

Remarks

This method enables you to scroll the contents of the control until the caret is within the visible region of the control. If the caret is positioned below the visible region of the control, the ScrollToCaret method will scroll the contents of the control until the caret is visible at the bottom of the control. If the caret is positioned above the visible region of the control, this method scrolls the contents of the control until the caret is visible at the top of the control. You can use this method in a multiline control to ensure that the current text entry point is within the visible region of the control. This method has no effect if the control does not have focus or if the caret is already positioned in the visible region of the control.

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

EditBase Class
EditBase Members