InputPane class

InputPane class

Enables an app to receive notifications when the input pane is about to be displayed or hidden, and to determine which portion of the application's window is obscured by the input pane.

The input pane appears when the user performs an action that requires them to enter information, such as selecting a text entry field.

Note  In some cases, overlay UI such as an InputPane is not fully supported. This includes:
 

Syntax


public ref class InputPane sealed 

Members

The InputPane class has these types of members:

Events

The InputPane class has these events.

EventDescription
Hiding Occurs when the input pane starts sliding out of view.
Showing Occurs when the input pane starts sliding into view.

 

Methods

The InputPane class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
GetForCurrentView Gets the InputPane object associated with the application window that is currently visible.
TryHide Hides the InputPane if it is showing.
TryShow Shows the InputPane if it is hidden.

 

Properties

The InputPane class has these properties.

PropertyAccess typeDescription

OccludedRect

Read-only

Gets the region of the app window obscured by the input pane.

Visible

Read/write

Gets or sets a value that indicates whether the input pane is shown.

 

Remarks

By default, Windows handles the input pane events and repositions content so that users can see where they are typing. Use this class to override this default behavior and create your own custom input pane.

Call GetForCurrentView to get an InputPane object.

After you register to receive input pane notifications, the system calls your event delegate whenever the input pane is shown or hidden for the window that was visible when you called the GetForCurrentView method.

Note  This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).
 

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.ViewManagement
Windows::UI::ViewManagement [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8

Namespace

Windows.UI.ViewManagement
Windows::UI::ViewManagement [C++]

Metadata

Windows.winmd

Attributes

[DualApiPartition()]
[MarshalingBehavior(Standard)]
[Muse()]
[Version(0x06020000)]

See also

Object

 

 

Show:
© 2016 Microsoft