PenInputPanel.InputFailed Event

Article
10/19/2012

Deprecated. Occurs when focus for input changes before the PenInputPanel object is able to insert user input into the attached control. PenInputPanel has been replaced by Microsoft.Ink.TextInput.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Event InputFailed As PenInputPanelInputFailedEventHandler
'Usage
Dim instance As PenInputPanel 
Dim handler As PenInputPanelInputFailedEventHandler 

AddHandler instance.InputFailed, handler

public event PenInputPanelInputFailedEventHandler InputFailed

public:
 event PenInputPanelInputFailedEventHandler^ InputFailed {
    void add (PenInputPanelInputFailedEventHandler^ value);
    void remove (PenInputPanelInputFailedEventHandler^ value);
}

JScript does not support events.

Remarks

The event handler receives an argument of type PenInputPanelInputFailedEventArgs containing data about this event.

The InputFailed event occurs when input focus changes before user input was inserted into the attached control. For example, if the user enters ink into the writing pad, then taps another edit control before the recognizer has had a chance to finish, this event fires.

By using the window handle passed into this event, you can choose to insert the text manually when this event occurs.

Important Note:
Starting with Microsoft® Windows® XP Tablet PC Edition 2005, the InputFailed event no longer applies. Text is always inserted before focus changes.

Security Note:
If using under partial trust, this event requires SecurityPermissionFlag.AllFlags permission, in addition to the permissions required by PenInputPanel. See Security and Trust.

Examples

This C# example creates two PenInputPanel objects, thePenInputPanel1 and thePenInputPanel2, and attaches them to TextBox controls, textBox1 and textBox2. The example adds a PenInputPanelInputFailedEventHandler, InputFailed_Event, to each PenInputPanel object. In the event handler, if focus has changed, the text is set in the previous TextBox control by setting its Text property.

//...

// Declare PenInputPanel objects
PenInputPanel thePenInputPanel1;
PenInputPanel thePenInputPanel2;

public Form1()
{
    // Required for Windows Form Designer support
    InitializeComponent();

    // Create, and attach new PenInputPanels to a TextBox controls.
    thePenInputPanel1 = new PenInputPanel(textBox1);
    thePenInputPanel2 = new PenInputPanel(textBox2);

    // Add an InputFailed event handler to each PenInputPanel
    thePenInputPanel1.InputFailed +=
        new PenInputPanelInputFailedEventHandler(InputFailed_Event);

    thePenInputPanel2.InputFailed +=
        new PenInputPanelInputFailedEventHandler(InputFailed_Event);
}

//...

public void InputFailed_Event(object sender,
PenInputPanelInputFailedEventArgs e)
{
    // Make sure the object that generated
    // the event is a PenInputPanel object
    if (sender is PenInputPanel)
    {
        PenInputPanel theSenderPanel = (PenInputPanel)sender;

        // Set the text in the previous control
        theSenderPanel.AttachedEditControl.Text += e.Text;
    }
}

This Microsoft Visual Basic® .NET example creates two PenInputPanel objects, thePenInputPanel1 and thePenInputPanel2, and attaches them to TextBox controls, textBox1 and textBox2. The example adds a PenInputPanelInputFailedEventHandler, InputFailed_Event, to each PenInputPanel object. In the event handler, if focus has changed, the text is set in the previous TextBox control by setting its Text property.

'...

' Declare the PenInputPanel objects
Dim thePenInputPanel1 As PenInputPanel
Dim thePenInputPanel2 As PenInputPanel

Public Sub New()
    MyBase.New()

    'This call is required by the Windows Form Designer.
    InitializeComponent()

    ' Create and attach new PenInputPanels to a TextBox controls.
    thePenInputPanel1 = New PenInputPanel(TextBox1)
    thePenInputPanel2 = New PenInputPanel(TextBox2)

    ' Add an InputFailed event handler to each PenInputPanel
    AddHandler thePenInputPanel1.InputFailed, AddressOf InputFailed_Event
    AddHandler thePenInputPanel2.InputFailed, AddressOf InputFailed_Event
End Sub 'New

'...

Public Sub InputFailed_Event(ByVal sender As Object, ByVal e As _
                             PenInputPanelInputFailedEventArgs)
    ' Make sure the object that generated
    ' the event is a PenInputPanel object
    If TypeOf sender Is PenInputPanel Then
        Dim thePenInputPanel As PenInputPanel = CType(sender, PenInputPanel)

        ' Set the text in the previous control
        thePenInputPanel.AttachedEditControl.Text += e.Text
    End If
End Sub 'InputFailed_Event

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

Share via