| -api-id | -api-type |
|---|---|
T:Windows.UI.ViewManagement.Core.CoreInputView |
winrt class |
Enables an app to control the display of a docked, undocked, moveable, or transitory input pane (and associated UI), receive notifications when the pane is moved, displayed, or hidden, and to determine which portion of the app's window is obscured by the pane.
Note
Not supported on HoloLens.
Primary view refers to either of the CoreInputViewKind.Keyboard or CoreInputViewKind.Handwriting views, while CoreInputView can be any of the values from CoreInputViewKind.Handwriting.
Used by frameworks (such as XAML) or custom text controls only.
Your app can use the info exposed by this object to adjust and reflow its UI to account for any occlusion.
The CoreInputView APIs support the following types of input panes.
- Docked Soft Input Panel (SIP) like the Touch keyboard and handwriting panel – typically, your app UI reflows.
- Floating toolbar or SIP – typically, your app UI does not reflow.
- Overlay panels such as inline Ink or IME candidate windows – typically, your app UI does not reflow for the edit control, but does reflow for the text/search suggestions.
The input pane appears when the user performs an action that requires them to provide information, such as entering a text field.
By default, Windows handles input pane events and repositions content so that users can see the control with focus. If you set CoreTextEditContext.InputPaneDisplayPolicy to Manual in your app, you are responsible for showing and hiding the input pane using TryShowPrimaryView and TryHidePrimaryView. Use this class to override the default behavior and customize the input pane.
Call GetForCurrentView to get a CoreInputView object.
After you register to receive input pane notifications, the system calls your event delegate whenever the 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).
| Windows version | SDK version | Value added |
|---|---|---|
| 1803 | 17134 | TryTransferXYFocusToPrimaryView |
| 1803 | 17134 | XYFocusTransferredToPrimaryView |
| 1803 | 17134 | XYFocusTransferringFromPrimaryView |
| 1809 | 17763 | TryHide |
| 1809 | 17763 | TryShow |
| 1809 | 17763 | TryShow(CoreInputViewKind) |
| 1903 | 18362 | GetForUIContext |
| 2004 | 19041 | PrimaryViewHiding |
| 2004 | 19041 | PrimaryViewShowing |