TextBoxBase.ScrollToCaret メソッド

定義

名前空間:

System.Windows.Forms

アセンブリ:

System.Windows.Forms.dll

コントロールの内容を現在のキャレット位置までスクロールします。

public:
 void ScrollToCaret();

public void ScrollToCaret ();

member this.ScrollToCaret : unit -> unit

Public Sub ScrollToCaret ()

例

次のコード例では、 列挙と ScrollToCaret メソッドをKeys使用して、キャレットで表されるテキスト挿入ポイントが、Enter キーを押した後に常に画面上に表示されるようにする方法を示します。 この例を実行するには、 というコントロールと というTextBox1コントロールをTextBox含むフォームに次のコードをRichTextBoxRichTextBox1貼り付けます。 この例では、イベント処理メソッドがイベントに 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

注釈

このメソッドを使用すると、キャレットがコントロールの可視領域内になるまでコントロールの内容をスクロールできます。 キャレットがコントロールの可視領域の下に配置されている場合、 ScrollToCaret メソッドはコントロールの下部にキャレットが表示されるまでコントロールの内容をスクロールします。 キャレットがコントロールの可視領域の上に配置されている場合、このメソッドは、キャレットがコントロールの上部に表示されるまでコントロールの内容をスクロールします。 このメソッドは、複数行のテキスト ボックスで使用して、現在のテキスト エントリ ポイントがコントロールの表示領域内にあることを確認できます。

注意

コントロールにフォーカスがない場合、またはキャレットがコントロールの可視領域に既に配置されている場合、このメソッドは無効です。