Spread Windows Forms 15.0
GrapeCity.Win.PluginInputMan Assembly / GrapeCity.Win.Spread.InputMan.CellType Namespace / GcTextBoxEditingControl Class / IsInputKey Method
One of the System.Windows.Forms.Keys values.


In This Topic
    IsInputKey Method (GcTextBoxEditingControl)
    In This Topic
    This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

    Determines whether the specified key is a regular input key or a special key that requires preprocessing.

    Syntax
    'Declaration
     
    
    Protected Overrides Function IsInputKey( _
       ByVal keyData As Keys _
    ) As Boolean
    'Usage
     
    
    Dim instance As GcTextBoxEditingControl
    Dim keyData As Keys
    Dim value As Boolean
     
    value = instance.IsInputKey(keyData)
    protected override bool IsInputKey( 
       Keys keyData
    )

    Parameters

    keyData
    One of the System.Windows.Forms.Keys values.

    Return Value

    true if the specified key is a regular input key; otherwise, false.
    Remarks
    Call the IsInputKey method to determine whether the key specified by the keyData parameter is an input key that the control requires. This method is called during window message preprocessing to determine whether the specified input key should be preprocessed or sent directly to the control. If IsInputKey returns true, the specified key is sent directly to the control. If IsInputKey returns false, the specified key is preprocessed and only sent to the control if it is not consumed by the preprocessing phase. Keys that are preprocessed include the Tab, Return, Esc, and the Up Arrow, Down Arrow, Left Arrow, and Right Arrow keys.
    See Also