TextBoxBase.ScrollToCaret Método

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Desplaza el contenido del control a la posición del símbolo de intercalación actual.

public:
 void ScrollToCaret();

public void ScrollToCaret ();

member this.ScrollToCaret : unit -> unit

Public Sub ScrollToCaret ()

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar la Keys enumeración y el ScrollToCaret método para asegurarse de que el punto de inserción de texto, representado por el símbolo de intercalación, siempre está visible en la pantalla después de presionar la tecla ENTRAR. Para ejecutar el ejemplo, pegue el código siguiente en un formulario que contiene un TextBox control denominado TextBox1 y un RichTextBox control denominado RichTextBox1. En este ejemplo se requiere que el método de control de eventos se haya asociado al KeyDown evento.

private:
   //Handles the Enter key being pressed while TextBox1 has focus. 
   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 = String::Concat( TextBox1->Text, "\r\n" );
         RichTextBox1->ScrollToCaret();
      }
   }

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

'Handles the Enter key being pressed while TextBox1 has focus. 
Private Sub TextBox1_KeyDown(ByVal sender As Object, _
    ByVal e As KeyEventArgs) Handles TextBox1.KeyDown
    TextBox1.HideSelection = False
    If e.KeyCode = Keys.Enter Then
        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 + _
            Microsoft.VisualBasic.vbCrLf
        RichTextBox1.ScrollToCaret()
    End If
End Sub

Comentarios

Este método permite desplazar el contenido del control hasta que el símbolo de intercalación esté dentro de la región visible del control. Si el símbolo de intercalación se coloca debajo de la región visible del control, el ScrollToCaret método desplazará el contenido del control hasta que el símbolo de intercalación esté visible en la parte inferior del control. Si el símbolo de intercalación está situado encima de la región visible del control, este método desplaza el contenido del control hasta que el símbolo de intercalación esté visible en la parte superior del control. Puede usar este método en un cuadro de texto de varias líneas para asegurarse de que el punto de entrada de texto actual está dentro de la región visible del control.

Nota

Este método no tiene ningún efecto si el control no tiene el foco o si el símbolo de intercalación ya está situado en la región visible del control.