PenInputPanel class

Article
01/07/2021

[Deprecated. PenInputPanel has been replaced by the Text Input Panel (TIP).]

The PenInputPanel object enables you to easily add in-place pen input to your applications.

The PenInputPanel object is available as an attachable object that allows you to add Tablet PC Input Panel functionality to existing controls. The user interface is largely mandated by the current input language. You have the option of choosing the default input method for the PenInputPanel object, either handwriting or keyboard. The end user can switch between input methods using buttons on the user interface.

PenInputPanel has these types of members:

Enumerations
Events
Interfaces
Methods
Properties

Enumerations

The PenInputPanel class has these enumerations.

Enumeration	Description
PanelType	Defines the type of input currently available in the PenInputPanel object.

Events

The PenInputPanel class has these events.

Event	Description
InputFailed	Occurs when input focus changes before the PenInputPanel object was able to insert user input into the attached control.
PanelChanged	Occurs when the PenInputPanel object changes between layouts.
PanelMoving	Occurs when the PenInputPanel object is moving.
VisibleChanged	Occurs when the PenInputPanel object has shown or hidden itself.

Interfaces

The PenInputPanel class defines these interfaces.

Interface	Description
IPenInputPanel	This object implements the IPenInputPanel COM interface.

Methods

The PenInputPanel class has these methods.

Method	Description
CommitPendingInput	Sends collected ink to the recognizer and posts the recognition result.
EnableTsf	When passed TRUE, the PenInputPanel attempts to send text to the attached control through the Text Services Framework (TSF) and enables the use of the correction user interface.
MoveTo	Sets the position of the PenInputPanel object to a static screen position.
Refresh	Updates and restores the PenInputPanel properties based on Tablet PC Input Panel settings, automatically positions the pen input panel and sets the user interface to the default panel.

Properties

The PenInputPanel class has these properties.

Property	Access type	Description
AttachedEditWindow	Read/write	Gets or sets the window handle of the control that the PenInputPanel object is attached to.
AutoShow	Read/write	Gets or sets a Boolean value that specifies whether the PenInputPanel object appears when focus is set using the pen.
Busy	Read-only	Gets a Boolean value that specifies whether the PenInputPanel object is currently processing ink.
CurrentPanel	Read/write	Gets or sets which panel type is currently being used for input within the PenInputPanel object.
DefaultPanel	Read/write	Gets or sets which panel type is the default panel type used for input within the PenInputPanel object.
Factoid	Read/write	Gets or sets the string name of the factoid used in recognition.
Height	Read-only	Gets the height of the PenInputPanel object in client coordinates.
HorizontalOffset	Read/write	Gets or sets the offset between the left edge of the PenInputPanel object and the left edge of the control to which it is attached.
Left	Read-only	Gets the horizontal, or x-axis, location of the left edge of the PenInputPanel object, in screen coordinates.
Top	Read-only	Gets the vertical, or y-axis, location of the top edge of the PenInputPanel object, in screen coordinates.
VerticalOffset	Read/write	Gets or sets the offset between the closest horizontal edge of the PenInputPanel object and the closest horizontal edge of the control to which it is attached.
Visible	Read/write	Gets or sets a value that indicates whether the PenInputPanel object is visible.
Width	Read-only	Gets the width of the PenInputPanel object in client coordinates.

Remarks

This object can be instantiated by calling the CoCreateInstance method in C++.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Header	Msinkaut.h (also requires Msinkaut_i.c)
Library	InkObj.dll