TextBoxBase.ScrollToCaret Méthode

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Fait défiler le contenu du contrôle vers la position indiquée par le signe insertion.

public:
 void ScrollToCaret();

public void ScrollToCaret ();

member this.ScrollToCaret : unit -> unit

Public Sub ScrollToCaret ()

Exemples

L’exemple de code suivant montre comment utiliser l’énumération Keys et la ScrollToCaret méthode pour s’assurer que le point d’insertion de texte, représenté par le caret, est toujours visible à l’écran une fois que la touche ENTRÉE a été enfoncée. Pour exécuter l’exemple, collez le code suivant dans un formulaire contenant un TextBox contrôle appelé TextBox1 et un RichTextBox contrôle appelé RichTextBox1. Cet exemple nécessite que la méthode de gestion des événements ait été associée à l’événement KeyDown .

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

Remarques

Cette méthode vous permet de faire défiler le contenu du contrôle jusqu’à ce que le caret se trouve dans la région visible du contrôle. Si le caret est positionné sous la région visible du contrôle, la ScrollToCaret méthode fait défiler le contenu du contrôle jusqu’à ce que le caret soit visible en bas du contrôle. Si le caret est positionné au-dessus de la région visible du contrôle, cette méthode fait défiler le contenu du contrôle jusqu’à ce que le caret soit visible en haut du contrôle. Vous pouvez utiliser cette méthode dans une zone de texte multiligne pour vous assurer que le point d’entrée de texte actuel se trouve dans la région visible du contrôle.

Notes

Cette méthode n’a aucun effet si le contrôle n’a pas de focus ou si le caret est déjà positionné dans la région visible du contrôle.