ITextInputPanel interface (peninputpanel.h)

ITextInputPanel is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use IInputPanelConfiguration interface.

Provides control of appearance and behavior of the Tablet PC Input Panel.

Inheritance

The ITextInputPanel interface inherits from the IUnknown interface. ITextInputPanel also has these types of members:

Methods

The ITextInputPanel interface has these methods.

 
ITextInputPanel::Advise

Establishes an advisory connection between the Tablet PC Input Panel and the specified sink object.
ITextInputPanel::CommitPendingInput

Sends collected ink to the recognizer and posts the recognition result.
ITextInputPanel::get_AttachedEditWindow

Gets or sets the window handle of the object to which the ITextInputPanel object is attached. (Get)
ITextInputPanel::get_CurrentCorrectionMode

Gets the current correction comb mode as specified by the CorrectionMode Enumeration.
ITextInputPanel::get_CurrentInPlaceState

Gets the current in-place state as specified by the InPlaceState Enumeration.
ITextInputPanel::get_CurrentInputArea

Gets the current input area as specified by the PanelInputArea Enumeration.
ITextInputPanel::get_CurrentInteractionMode

Gets the positioning of the Tablet PC Input Panel as specified by the InteractionMode Enumeration.
ITextInputPanel::get_DefaultInPlaceState

Gets or sets the default in-place state as specified by the InPlaceState Enumeration. (Get)
ITextInputPanel::get_DefaultInputArea

Gets or sets the default input area as specified by the PanelInputArea Enumeration. (Get)
ITextInputPanel::get_ExpandPostInsertionCorrection

Gets or sets a value that indicates whether the correction comb on the Tablet PC Input Panel is automatically expanded. (Get)
ITextInputPanel::get_InPlaceBoundingRectangle

Gets the bounding rectangle for Tablet PC Input Panel.
ITextInputPanel::get_InPlaceVisibleOnFocus

Gets or sets a value that indicates whether the Tablet PC Input Panel is displayed automatically when the window to which it is attached gets focus. (Get)
ITextInputPanel::get_PopDownCorrectionHeight

Gets the height of the Post-Insertion correction comb when it is positioned below Input Panel.
ITextInputPanel::get_PopUpCorrectionHeight

Gets the height of the Post-Insertion correction comb when it is positioned above Input Panel.
ITextInputPanel::get_PreferredInPlaceDirection

Gets or sets the preferred direction of the in-place Input Panel relative to the text entry field. (Get)
ITextInputPanel::put_AttachedEditWindow

Gets or sets the window handle of the object to which the ITextInputPanel object is attached. (Put)
ITextInputPanel::put_DefaultInPlaceState

Gets or sets the default in-place state as specified by the InPlaceState Enumeration. (Put)
ITextInputPanel::put_DefaultInputArea

Gets or sets the default input area as specified by the PanelInputArea Enumeration. (Put)
ITextInputPanel::put_ExpandPostInsertionCorrection

Gets or sets a value that indicates whether the correction comb on the Tablet PC Input Panel is automatically expanded. (Put)
ITextInputPanel::put_InPlaceVisibleOnFocus

Gets or sets a value that indicates whether the Tablet PC Input Panel is displayed automatically when the window to which it is attached gets focus. (Put)
ITextInputPanel::put_PreferredInPlaceDirection

Gets or sets the preferred direction of the in-place Input Panel relative to the text entry field. (Put)
ITextInputPanel::SetInPlaceHoverTargetPosition

Explicitly positions the Tablet PC Input Panel hover target in screen coordinates.
ITextInputPanel::SetInPlacePosition

Explicitly positions the Tablet PC Input Panel in screen coordinates.
ITextInputPanel::SetInPlaceVisibility

Shows or hides the Tablet PC Input Panel.
ITextInputPanel::Unadvise

Terminates an advisory connection previously established through ITextInputPanel::Advise Method.

Remarks

ITextInputPanel Interface gives application developers more control and information about Input Panel's state than PenInputPanel Class. ITextInputPanel Interface replaces the PenInputPanel Class as the preferred mechanism for programmatically interacting with the Input Panel.

ITextInputPanel Interface provides:

  • A complete control over the positioning of the in-place Input Panel when the application has focus.
  • An access to the ink objects from the Input Panel text insertion in addition to the recognized text.
  • A set of properties that correspond exactly to Input Panel's capabilities giving both the ability to know Input Panel's current state and to customize Input Panel's configuration.
The ITextInputPanel Interface continues to provide nearly all of the programmatic capabilities of the PenInputPanel Class thus superseding the PenInputPanel Class.

This element is declared in Peninputpanel.h.

Requirements

Requirement Value
Minimum supported client Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header peninputpanel.h