CoreInputView クラス

定義

名前空間:

Windows.UI.ViewManagement.Core

アプリがドッキング、ドッキング解除、移動可能、または推移的な入力ウィンドウ (および関連する UI) の表示を制御し、ウィンドウが移動、表示、または非表示になったときに通知を受け取り、アプリのウィンドウのどの部分がウィンドウで隠されているかを判断できるようにします。

注意

HoloLens ではサポートされていません。

public ref class CoreInputView sealed

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

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

Public NotInheritable Class CoreInputView

継承

Object Platform::Object IInspectable CoreInputView

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

デバイス ファミリ	Windows 10 Fall Creators Update (10.0.16299.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v5.0 で導入)

注釈

プライマリ ビューは CoreInputViewKind.Keyboard ビューまたは CoreInputViewKind.Handwriting ビューのいずれかを参照しますが、CoreInputView には CoreInputViewKind.Handwriting の値を指定できます。

フレームワーク (XAML など) またはカスタム テキスト コントロールでのみ使用されます。

アプリでは、このオブジェクトによって公開されている情報を使用して、その UI を調整してリフローし、オクルージョンを考慮することができます。

CoreInputView API では、次の種類の入力ウィンドウがサポートされています。

• タッチ キーボードや手書きパネルなどのドッキングされたソフト入力パネル (SIP) -通常は、アプリ UI がリフローされます。
• フローティング ツール バーまたは SIP - 通常、アプリ UI はリフローされません。
• インライン Ink や IME 候補ウィンドウなどのオーバーレイ パネル - 通常、アプリ UI は編集コントロールのリフローを行いませんが、テキスト/検索候補のリフローを行います。

入力ウィンドウは、ユーザーがテキスト フィールドの入力などの情報の提供を要求するアクションを実行すると表示されます。

既定では、Windows は入力ウィンドウ イベントを処理し、コンテンツの位置を変更して、ユーザーがフォーカスを持つコントロールを表示できるようにします。 アプリで CoreTextEditContext.InputPaneDisplayPolicy を Manual に設定した場合、 TryShowPrimaryView と TryHidePrimaryView を使用して入力ウィンドウを表示および非表示にする必要があります。 このクラスを使用して、既定の動作をオーバーライドし、入力ウィンドウをカスタマイズします。

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

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

注意

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

バージョン履歴

Windows のバージョン	SDK バージョン	追加された値
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

メソッド

GetCoreInputViewOcclusions()	現在アプリを隠している各入力ウィンドウへの参照を取得します。
GetForCurrentView()	現在のウィンドウに関連付けられている CoreInputView オブジェクトを取得します。
GetForUIContext(UIContext)	指定したコンテキスト識別子を持つビューに関連付けられた CoreInputView オブジェクトを取得します。
IsKindSupported(CoreInputViewKind)	指定した CoreInputView の型がサポートされているかどうかを取得します。
TryHide()	CoreInputView ペインに関連付けられている入力ペインを非表示 (表示されている場合) しようとします。
TryHidePrimaryView()	CoreInputView に関連付けられている入力ウィンドウを非表示 (表示されている場合) しようとします。
TryShow()	CoreInputView に関連付けられている入力ウィンドウを表示しようとします (非表示の場合)。
TryShow(CoreInputViewKind)	CoreInputView に関連付けられている指定した種類の入力ウィンドウを表示しようとします (非表示の場合)。
TryShowPrimaryView()	CoreInputView ペインを表示 (非表示の場合) しようとします。 このメソッドは "ベスト エフォート" であり、ユーザーがフォーカスされたコントロールと対話する方法があることを保証します。 タッチ キーボードや手書きパネルなどのソフト入力パネル (SIP) がドッキングされている場合、ウィンドウはハードウェア キーボードが使用できない場合にのみ表示されます。
TryTransferXYFocusToPrimaryView(Rect, CoreInputViewXYFocusTransferDirection)	アプリケーション UI から入力ウィンドウにフォーカスを移動しようとします。

イベント

OcclusionsChanged	CoreInputView に関連付けられている入力ウィンドウの位置変更に応じて、1 つ以上の CoreInputViewOcclusion オブジェクトが位置または隠し領域を変更したときに発生します。
PrimaryViewAnimationStarting	CoreInputView プライマリ ビューの表示または非表示に応じて発生するアプリケーション内のアニメーション。
PrimaryViewHiding	CoreInputView に関連付けられている入力ウィンドウが非表示の前に発生します (表示されている場合)。
PrimaryViewShowing	CoreInputView に関連付けられている入力ウィンドウが表示される前に発生します (非表示の場合)。
SupportedKindsChanged	CoreInputView のサポートされている CoreInputViewKind ビューのコレクションが変更されたときに発生します。
XYFocusTransferredToPrimaryView	アプリケーション UI から入力ウィンドウにフォーカスが移動したときに発生します。
XYFocusTransferringFromPrimaryView	入力ウィンドウがフォーカスを失う前と、UI 要素がフォーカスを取得する前に発生します。

こちらもご覧ください

• CoreFrameworkInputView