CoreFrameworkInputView Class

Reference

Definition

Namespace:: Windows.UI.ViewManagement.Core

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Provides UI frameworks with the ability to handle PrimaryViewAnimationStarting and OcclusionsChanged events after the corresponding CoreInputView PrimaryViewAnimationStarting and OcclusionsChanged events.

This enables a framework 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.

public ref class CoreFrameworkInputView sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 851968)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CoreFrameworkInputView final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 851968)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class CoreFrameworkInputView

Public NotInheritable Class CoreFrameworkInputView

Inheritance: Object Platform::Object IInspectable CoreFrameworkInputView

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 11 (introduced in 10.0.22000.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v14.0)

Remarks

Used by frameworks (such as XAML) or custom text controls only.

The framework can use the info exposed by this object to adjust and reflow UI to account for any occlusion.

The CoreFrameworkInputView 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.

Call CoreFrameworkInputView.GetForCurrentView to get a CoreFrameworkInputView object.

After you register to receive input pane notifications, the system calls your event delegate whenever the pane is shown or hidden for the foreground window when you called the CoreFrameworkInputView.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).

Methods

GetForCurrentView()	Retrieves the CoreFrameworkInputView object associated with the current window.
GetForUIContext(UIContext)	Gets a CoreFrameworkInputView object associated with the view having the specified context identifier.

Events

OcclusionsChanged	Occurs when one or more CoreInputViewOcclusion objects change their position or occluding area in response to the repositioning of the input pane associated with the CoreFrameworkInputView.
PrimaryViewAnimationStarting	Animations in the application that occur in response to the showing or hiding of the input pane associated with the CoreFrameworkInputView.

Applies to

Share via