InputPane クラス

リファレンス

定義

名前空間:: Windows.UI.ViewManagement

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

ドッキングされたタッチキーボードまたはソフト入力パネル (SIP) が表示または非表示になり、アプリケーションのウィンドウのどの部分が入力ウィンドウで隠れているかを判断するときに、アプリで通知を受信できるようにします。

Note

InputPane API は、ドッキングされたパネルに対してのみ正確なオクルージョン情報を提供します。 Windows 10 Creators Fall Update 以降では、次の API を使用して、ドッキング、ドッキング解除、移動可能、および一時的な入力ウィンドウ (ソフト入力パネル (SIP)、入力方法エディター (IME) 候補ウィンドウ、フローティングツールバーなど) によるオクルージョンを処理することをお勧めします。

public ref class InputPane sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class InputPane final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class InputPane

Public NotInheritable Class InputPane

継承: Object Platform::Object IInspectable InputPane

属性: ContractVersionAttribute MarshalingBehaviorAttribute

Windows の要件

デバイスファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

注釈

入力ウィンドウは、ユーザーがテキスト入力フィールドの選択などの情報の入力を要求するアクションを実行したときに表示されます。既定では、Windows は入力ウィンドウのイベントを処理し、ユーザーが入力している場所を確認できるようにコンテンツの位置を変更します。アプリで CoreTextEditContext.InputPaneDisplayPolicy を Manual に設定した場合は、TryShow と TryHide を使用して入力ウィンドウを表示および非表示にする必要があります。このクラスを使用して、既定の動作をオーバーライドし、入力ウィンドウをカスタマイズします。

場合によっては、InputPane などのオーバーレイ UI が完全にはサポートされていません。これには次のものが含まれます

ゲームなどの全画面表示モードのアプリ。
ホログラフィックビューの Windows Holographic アプリ。

InputPane オブジェクトを取得するには、 GetForCurrentView を呼び出します。

入力ウィンドウ通知を受信するように登録すると、 GetForCurrentView メソッドを呼び出したときに表示されていたウィンドウに対して入力ウィンドウが表示または非表示になると、システムはイベントデリゲートを呼び出します。

Note

このクラスはアジャイルではありません。つまり、スレッドモデルとマーシャリング動作を考慮する必要があります。詳細については、「スレッドとマーシャリング (C++/CX)」を参照してください。

バージョン履歴

Windows のバージョン	SDK バージョン	追加された値
1903	18362	GetForUIContext

プロパティ

OccludedRect

入力ウィンドウで隠されたアプリウィンドウの領域を取得します。

Visible

入力ウィンドウが表示されるかどうかを示す値を取得または設定します。

重要

Xbox デバイスファミリでのみ有効です。

ユニバーサルアプリの場合、 OccludedRect プロパティは、入力ウィンドウによって妨げられるアプリウィンドウの領域を示します。

メソッド

GetForCurrentView()	現在表示されているアプリケーションウィンドウに関連付けられている InputPane オブジェクトを取得します。
GetForUIContext(UIContext)	指定したコンテキスト識別子を持つビューに関連付けられている InputPane オブジェクトを取得します。
TryHide()	InputPane が表示されている場合は非表示にしようとします。
TryShow()	InputPane が非表示の場合は、その表示を試みます。このメソッドは "ベストエフォート" であり、ユーザーがフォーカスされたコントロールにテキストを入力する方法があることを保証するだけです。タッチキーボードまたはソフト入力パネル (SIP) は、ハードウェアキーボードが使用できない場合にのみ表示されます。

イベント

Hiding	入力ウィンドウが表示されなくなっているときに発生します。
Showing	入力ウィンドウがビューにスライドし始めると発生します。

適用対象

こちらもご覧ください

タッチキーボードの表示への応答