Export (0) Print
Expand All

TextBoxBase.ScrollToCaret Method

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public void ScrollToCaret()

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 text box to ensure that the current text entry point is within the visible region of the control.

NoteNote

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.

The following code example demonstrates how to use the Keys enumeration and the ScrollToCaret method to ensure that the text insertion point, represented by the caret, is always visible on the screen after the ENTER key has been pressed. To run the example, paste the following code in a form containing a TextBox control called TextBox1 and a RichTextBox control called RichTextBox1. This example requires that the event-handling method has been associated with the KeyDown event.


	//Handles the Enter key being pressed while TextBox1 has focus. 
	private void TextBox1_KeyDown(object sender, KeyEventArgs e)
	{
		TextBox1.HideSelection = false;
		if (e.KeyCode==Keys.Enter)
		{
			e.Handled = true;

			// Copy the text from TextBox1 to RichTextBox1, add a CRLF after 
			// the copied text, and keep the caret in view.
			RichTextBox1.SelectedText = TextBox1.Text + "\r\n";
			RichTextBox1.ScrollToCaret();
		}
	}



The following code example demonstrates how use the Keys enumeration and the TextBoxBase.ScrollToCaret method. To run the example, paste the following code
in a form containing a TextBox control called TextBox1 and a RichTextBox control called RichTextBox1. This example assumes the event-handling method has been associated with the KeyDown event.


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft