TextBoxBase.ScrollToCaret メソッド

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

Public Sub ScrollToCaret()
[C#]
public void ScrollToCaret();
[C++]
public: void ScrollToCaret();
[JScript]
public function ScrollToCaret();

解説

このメソッドを使用すると、カレットがコントロールの表示領域内に入るまでコントロールの内容をスクロールできるようになります。カレットがコントロールの表示領域より下にある場合、 ScrollToCaret メソッドは、カレットがコントロールの一番下に表示されるまでコントロールの内容をスクロールします。カレットがコントロールの表示領域より上にある場合、このメソッドは、カレットがコントロールの一番上に表示されるまでコントロールの内容をスクロールします。このメソッドを複数行テキスト ボックスで使用すると、テキスト エントリ ポイントをコントロールの表示領域内に確実に入れられます。

メモ   コントロールにフォーカスがない場合、またはカレットが既にコントロールの表示領域に位置している場合、このメソッドは無効です。

使用例

[Visual Basic, C#] Keys 列挙体と ScrollToCaret メソッドの使用方法を示すコード例を次に示します。この例を実行するには、TextBox1 という名前の TextBox コントロールと RichTextBox1 という名前の RichTextBox コントロールが配置されているフォームに、次のコードを貼り付けます。この例は、イベントを処理するメソッドが KeyDown イベントに関連付けられていることを前提としています。

 
'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

[C#] 
//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();
    }
}

[C++, JScript] C++ および JScript のサンプルはありません。Visual Basic および C# のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン をクリックします。

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ, .NET Compact Framework - Windows CE .NET

参照

TextBoxBase クラス | TextBoxBase メンバ | System.Windows.Forms 名前空間