InputPane class

Applies to Windows and Windows Phone

Enables an app to register 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 being obscured by the input pane.

The input pane is a UI element that appears when the user performs an action that requires them to enter information, such as tapping a search box or an entry field in a form.

Syntax


var inputPane = Windows.UI.ViewManagement.InputPane;

Attributes

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

Members

The InputPane class has these types of members:

Events

The InputPane class has these events.

EventDescription
Hiding Occurs when the input pane is about to be hidden by sliding out of view.
Showing Occurs when the input pane is about to be displayed by 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-onlyGets the region of the application’s window that the input pane is covering.

 

Remarks

By default the Windows handles the input pane events for you and repositions your content on screen so that users can see where they are typing. Use this class if you are creating a DirectX app or if you'd like to override the default behavior of the framework to 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

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8

Namespace

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

Metadata

Windows.winmd

 

 

Show:
© 2014 Microsoft