ITextProvider2::GetCaretRange メソッド (uiautomationcore.h)

  • [アーティクル]

テキスト ベースのコントロールに属するキャレットの位置に長さ 0 のテキスト範囲を提供します。

構文

HRESULT GetCaretRange(
  [out]         BOOL               *isActive,
  [out, retval] ITextRangeProvider **pRetVal
);

パラメーター

[out] isActive

種類: BOOL*

キャ レットを含むテキスト ベースのコントロールにキーボード フォーカスがある場合は TRUE、それ以外の場合は FALSE。

[out, retval] pRetVal

種類: ITextRangeProvider**

テキスト ベースのコントロールに属するキャレットの現在の位置を表すテキスト範囲。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

isActive パラメーターが FALSE の場合、テキスト ベースのコントロールに属するキャレットがシステム キャレットと同じ場所にない可能性があります。

このメソッドは、クライアントがテキスト ベースのコントロールに属するキャレットの外接する四角形を検索したり、キャレットの近くのテキストを検索したりするために使用できるテキスト範囲を取得します。

要件

要件 値
サポートされている最小のクライアント Windows 8 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2012 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー uiautomationcore.h (UIAutomation.h を含む)

こちらもご覧ください

ITextProvider2