InputPaneVisibilityEventArgs InputPaneVisibilityEventArgs InputPaneVisibilityEventArgs InputPaneVisibilityEventArgs Class

Provides data for the input pane Hiding and Showing events.

Note

In some cases, overlay UI such as an InputPane is not fully supported. This includes:+ apps in full-screen mode.

Syntax

Declaration

public sealed class InputPaneVisibilityEventArgspublic sealed class InputPaneVisibilityEventArgsPublic NotInheritable Class InputPaneVisibilityEventArgs

Remarks

Your app receives this class in its Hiding and Showing event handlers.

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).

Properties summary

Identifies whether the application has taken steps to ensure that the input pane doesn't cover the UI element that has focus.

Gets the region of the application's window that the input pane is covering.

Properties

  • EnsuredFocusedElementInView
    EnsuredFocusedElementInView
    EnsuredFocusedElementInView
    EnsuredFocusedElementInView

    Identifies whether the application has taken steps to ensure that the input pane doesn't cover the UI element that has focus.

    public bool EnsuredFocusedElementInView { get; set; }public bool EnsuredFocusedElementInView { get; set; }Public ReadWrite Property EnsuredFocusedElementInView As bool

    Property Value

    • bool
      bool
      bool
      bool

      True if the application has ensured that the input pane isn't covering the UI element that has focus; otherwise false.

    Remarks

    If this property is false, Windows ensures that the input pane doesn't cover the focused element.

    If you do the work to ensure that the focused element isn't covered, be sure to set this property to true to prevent Windows from trying to do the same work; otherwise, the results can be unpredictable.

    In some cases, overlay UI such as an InputPane is not fully supported. This includes:+ apps in full-screen mode.

  • OccludedRect
    OccludedRect
    OccludedRect
    OccludedRect

    Gets the region of the application's window that the input pane is covering.

    public Rect OccludedRect { get; }public Rect OccludedRect { get; }Public ReadOnly Property OccludedRect As Rect

    Property Value

    • The window region that the input pane is covering, in client coordinates specified in device independent pixels (DIPs).

    Remarks

    In some cases, overlay UI such as an InputPane is not fully supported. This includes:+ apps in full-screen mode.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.UI.ViewManagement.dll