PenInputPanel Class

Article
10/16/2006

PenInputPanel Class

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

Definition

Visual Basic .NET Public Class PenInputPanel
Inherits Object
Implements IDisposable

C# public class PenInputPanel : Object,
IDisposable

Managed C++ public __gc class PenInputPanel : public Object,
IDisposable

Members Table

The following table lists the members exposed by the object.

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.

Methods

Method Description

CommitPendingInput Sends collected ink to the recognizer and posts the result.

Dispose Releases resources used by the PenInputPanel object.

EnableTsf Indicates whether or not the PenInputPanel object attempts to send text to the attached control through the Text Services Framework (TSF) and enables the use of the correction user interface.

Equals Determines whether two Object instances are equal. Inherited from Object .

Finalize Frees the resources of the current PenInputPanel object before it is reclaimed by the garbage collector.

GetHashCode Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. Inherited from Object .

GetType Gets the Type of the current instance. Inherited from Object .

MemberwiseClone Creates a shallow copy of the current Object . Inherited from Object .

MoveTo Sets the position of the PenInputPanel object to a defined screen position.

OnInputFailed Allows derived classes to modify the default behavior of the InputFailed event.

OnPanelChanged Allows derived classes to modify the default behavior of the PanelChanged event.

OnPanelMoving Allows derived classes to modify the default behavior of the PanelMoving event.

OnVisibleChanged Allows derived classes to modify the default behavior of the VisibleChanged event.

PenInputPanel Initializes a new instance of the PenInputPanel class.

ReferenceEquals Determines whether the specified Object instances are the same instance. Inherited from Object .

Refresh Updates and restores the PenInputPanel properties based on Tablet PC Input Panel, automatically positions the pen input panel, and sets the user interface to the default panel.

ToString Returns a String that represents the current Object . Inherited from Object .

Properties

Property Description

AttachedEditControl Gets or sets the control that the PenInputPanel object is attached to.

AttachedEditWindow Gets or sets the window handle that the PenInputPanel object is attached to.

AutoShow Gets or sets a Boolean value that indicates whether the pen input panel appears when focus is set on the attached control by using the pen.

Busy Gets a Boolean value that indicates whether the PenInputPanel object is currently processing ink.

CurrentPanel Gets or sets which panel type is currently being used for input within the PenInputPanel object.

DefaultPanel Gets or sets the default panel type used for input within the PenInputPanel object.

Factoid Gets or sets the string name of the factoid used by the PenInputPanel object.

Height Gets the height of the pen input panel in client coordinates.

HorizontalOffset Gets or sets the offset between the left edge of the pen input panel and the left edge of the control to which it is attached.

Left Gets the horizontal, or x-axis, location of the left edge of the PenInputPanel object, in screen coordinates.

Top Gets the vertical, or y-axis, location of the top edge of the PenInputPanel object, in screen coordinates.

VerticalOffset Gets or sets the offset between the closest horizontal edge of the pen input panel and the closest horizontal edge of the control to which it is attached.

Visible Gets or sets a value that indicates whether the PenInputPanel object is visible.

Width Gets the width of the pen input panel in client coordinates.

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.

Method	Description
CommitPendingInput	Sends collected ink to the recognizer and posts the result.
Dispose	Releases resources used by the PenInputPanel object.
EnableTsf	Indicates whether or not the PenInputPanel object attempts to send text to the attached control through the Text Services Framework (TSF) and enables the use of the correction user interface.
Equals	Determines whether two Object instances are equal. Inherited from Object .
Finalize	Frees the resources of the current PenInputPanel object before it is reclaimed by the garbage collector.
GetHashCode	Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. Inherited from Object .
GetType	Gets the Type of the current instance. Inherited from Object .
MemberwiseClone	Creates a shallow copy of the current Object . Inherited from Object .
MoveTo	Sets the position of the PenInputPanel object to a defined screen position.
OnInputFailed	Allows derived classes to modify the default behavior of the InputFailed event.
OnPanelChanged	Allows derived classes to modify the default behavior of the PanelChanged event.
OnPanelMoving	Allows derived classes to modify the default behavior of the PanelMoving event.
OnVisibleChanged	Allows derived classes to modify the default behavior of the VisibleChanged event.
PenInputPanel	Initializes a new instance of the PenInputPanel class.
ReferenceEquals	Determines whether the specified Object instances are the same instance. Inherited from Object .
Refresh	Updates and restores the PenInputPanel properties based on Tablet PC Input Panel, automatically positions the pen input panel, and sets the user interface to the default panel.
ToString	Returns a String that represents the current Object . Inherited from Object .

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

Inheritance Hierarchy

Object

PenInputPanel

Remarks

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.

Caution: You must call the Dispose method on this object before it goes out of scope. This object maintains non-managed resources. Relying on finalization for this object can cause memory leaks and exceptions within your application.

For an example of disposing managed objects, see Using the Managed Library.

Class Information

Namespace Microsoft.Ink

Assembly Microsoft.Ink (microsoft.ink.dll)

Strong Name Microsoft.Ink, Version=1.7.4009.0, Culture=neutral, PublicKeyToken=a2870d9cc4d021c8

Partager via

PenInputPanel Class

PenInputPanel Class

Ressources supplémentaires

Visual Basic .NET	Public Class PenInputPanel Inherits Object Implements IDisposable
C#	public class PenInputPanel : Object, IDisposable
Managed C++	public __gc class PenInputPanel : public Object, IDisposable

Namespace	Microsoft.Ink
Assembly	Microsoft.Ink (microsoft.ink.dll)
Strong Name	Microsoft.Ink, Version=1.7.4009.0, Culture=neutral, PublicKeyToken=a2870d9cc4d021c8