ITextInputPanel::SetInPlaceVisibility メソッド (peninputpanel.h)

[アーティクル]
03/01/2024

[ITextInputPanel は、[要件] セクションで指定されたオペレーティングシステムで使用できます。今後のバージョンでは変更されるか、利用できなくなる場合もあります。代わりに、 IInputPanelConfiguration を使用します。

]

タブレット PC 入力パネルの表示/非表示を切り替えます。

構文

HRESULT SetInPlaceVisibility(
  BOOL Visible
);

パラメーター

Visible

入力パネルを表示する場合は TRUE。入力パネルを非表示にする場合は FALSE。

戻り値

入力パネルを表示できる場合、メソッドは S_OKを返します。それ以外の場合 はE_FAIL。入力パネルが ITextInputPanel::SetInPlaceVisibility メソッドの影響を受けることができる場合と影響を受けることができない場合の詳細については、「解説」セクションを参照してください。

リターンコード	説明
S_OK	正常終了しました。
E_FAIL	未指定のエラーが発生しました。

解説

入力パネルは、 ITextInputPanel::CurrentInPlaceState プロパティによって指定されたとおりに表示されます。

Visible パラメーターを TRUE に設定して ITextInputPanel::SetInPlaceVisibility メソッドを呼び出すと、入力パネルが既に表示されている場合は失敗します。

ユーザーが [入力パネル] オプションダイアログでインプレースモードを無効にした場合、 ITextInputPanel::SetInPlaceVisibility メソッド の呼び出しは失敗します。

入力パネルに既に表示されているインクは、表示が変更されると自動的に挿入されます。

このメソッドは ITextInputPanel::InPlaceVisibleOnFocus プロパティの値を変更せず、後続のフォーカスの変更では、 動作は ITextInputPanel::InPlaceVisibleOnFocus プロパティで指定された動作に戻ります。

ITextInputPanel::SetInPlaceVisibility メソッドは同期呼び出しです。入力パネルの可視性は、呼び出しが戻る前に変更されます。

例

この C++ の例では、EN_SETFOCUSIDC_EDIT1Edit コントロールのイベントハンドラーを実装します。最初に、 ITextInputPanel オブジェクトが作成されているかどうかを確認します g_pTip。存在する場合、Visible パラメーターの値が false の ITextInputPanel::SetInPlaceVisibility メソッドを呼び出すことで、入力パネルが表示されなくなります。

void CCOMTIPDlg::OnEnSetfocusEdit1()
{
	if (NULL != g_pTip)
	{
		if (SUCCEEDED(g_pTip->SetInPlaceVisibility(false)))
		{
			TRACE("Successfully hid the Input Panel.\n");
		}
	}
}

要件

要件	値
サポートされている最小のクライアント	Windows XP タブレット PC エディション [デスクトップアプリのみ]
サポートされている最小のサーバー	サポートなし
対象プラットフォーム	Windows
ヘッダー	peninputpanel.h
[DLL]	Tiptsf.dll