Control.IsInputKey(Keys) メソッド

定義

名前空間:
System.Windows.Forms
アセンブリ:
System.Windows.Forms.dll

指定したキーが通常の入力キーか、前処理を必要とする特殊なキーかを判断します。

protected:
 virtual bool IsInputKey(System::Windows::Forms::Keys keyData);
protected virtual bool IsInputKey(System.Windows.Forms.Keys keyData);
abstract member IsInputKey : System.Windows.Forms.Keys -> bool
override this.IsInputKey : System.Windows.Forms.Keys -> bool
Protected Overridable Function IsInputKey (keyData As Keys) As Boolean

パラメーター

keyData
Keys

Keys値の 1 つ。

返品

Boolean

true 指定されたキーが通常の入力キーの場合。それ以外の場合は false。

例

次のコード例は、TextBox コントロールのIsInputKey メソッドをオーバーライドする方法を示しています。 この例では、 TabTextBox クラスが TAB キーを処理します。 TabTextBoxにフォーカスがあり、ユーザーが Tab キーを押すと、テキストの挿入ポイントに 4 つのスペースが追加され、選択したテキストが置き換えられます。 既定では、 TextBox コントロールは、入力フォーカスを次のコントロールに移動することによって TAB キーを処理します。 この場合、keypress は OnKeyDown メソッドのオーバーライドに到達しません。 この既定の動作を回避するために、 IsInputKey メソッドのオーバーライドは、ユーザーが Tab キーを押したときに true を返します。 他のすべてのキー押下の場合、 IsInputKey メソッドのオーバーライドは、メソッドの基底クラス バージョンを呼び出した結果を返します。

using System.Windows.Forms;

public class Form1 : Form
{
    public Form1()
    {
        FlowLayoutPanel panel = new FlowLayoutPanel();

        TabTextBox tabTextBox1 = new TabTextBox();
        tabTextBox1.Text = "TabTextBox";
        panel.Controls.Add(tabTextBox1);

        TextBox textBox1 = new TextBox();
        textBox1.Text = "Normal TextBox";
        panel.Controls.Add(textBox1);

        this.Controls.Add(panel);
    }
}

class TabTextBox : TextBox
{
    protected override bool IsInputKey(Keys keyData)
    {
        if (keyData == Keys.Tab)
        {
            return true;
        }
        else
        {
            return base.IsInputKey(keyData);
        }
    }

    protected override void OnKeyDown(KeyEventArgs e)
    {
        if (e.KeyData == Keys.Tab)
        {
            this.SelectedText = "    ";                
        }
        else
        {
            base.OnKeyDown(e);
        }
    }
}

Imports System.Windows.Forms

Public Class Form1
    Inherits Form

    Public Sub New()

        Dim panel As New FlowLayoutPanel()

        Dim tabTextBox1 As New TabTextBox()
        tabTextBox1.Text = "TabTextBox"
        panel.Controls.Add(tabTextBox1)

        Dim textBox1 As New TextBox()
        textBox1.Text = "Normal TextBox"
        panel.Controls.Add(textBox1)

        Me.Controls.Add(panel)

    End Sub

End Class

Class TabTextBox
    Inherits TextBox

    Protected Overrides Function IsInputKey( _
        ByVal keyData As System.Windows.Forms.Keys) As Boolean

        If keyData = Keys.Tab Then
            Return True
        Else
            Return MyBase.IsInputKey(keyData)
        End If

    End Function

    Protected Overrides Sub OnKeyDown( _
        ByVal e As System.Windows.Forms.KeyEventArgs)

        If e.KeyData = Keys.Tab Then
            Me.SelectedText = "    "
        Else
            MyBase.OnKeyDown(e)
        End If

    End Sub

End Class

注釈

IsInputKey メソッドを呼び出して、keyData パラメーターで指定されたキーがコントロールに必要な入力キーであるかどうかを判断します。 このメソッドは、ウィンドウ メッセージの前処理中に呼び出され、指定した入力キーを前処理するか、コントロールに直接送信するかを決定します。 IsInputKeyがtrueを返す場合、指定したキーがコントロールに直接送信されます。 IsInputKeyがfalseを返す場合、指定したキーは前処理され、前処理フェーズで使用されていない場合にのみコントロールに送信されます。 前処理されるキーには、TAB キー、RETURN キー、ESC キー、上方向キー、下方向キー、左方向キー、右方向キーがあります。

適用対象

こちらもご覧ください