IDWriteTextLayout::HitTestTextPosition メソッド

アプリケーションは、この関数を呼び出して、テキスト位置とその位置の論理側面が指定されたレイアウト ボックスの左上を基準としたピクセル位置を取得します。通常、この関数は、現在のテキスト編集位置に対応する場所でキャレットが描画される、テキストのキャレット配置の一環として使用されます。また、UI オートメーションで特定のテキスト位置のジオメトリをプログラムによって取得する方法として使用されることもあります。

構文

virtual HRESULT HitTestTextPosition(
         UINT32  textPosition,
         BOOL  isTrailingHit,
  [out]  FLOAT * pointX,
  [out]  FLOAT * pointY,
  [out]  DWRITE_HIT_TEST_METRICS * hitTestMetrics
) = 0;

パラメーター

• textPosition
  ピクセル位置を取得するために使用されるテキスト位置。

• isTrailingHit
  ピクセル位置が、指定されたテキスト位置の前方または後方であるかどうかを示すブール値のフラグ。

• pointX [out]
  このメソッドが返されるときに、レイアウト ボックスの左上を基準とした出力ピクセル位置 X が格納されます。

• pointY [out]
  このメソッドが返されるときに、レイアウト ボックスの左上を基準とした出力ピクセル位置 Y が格納されます。

• hitTestMetrics [out]
  このメソッドが返されるときに、指定されたテキスト位置を完全に囲む出力ジオメトリが格納されます。

戻り値

メソッドが成功した場合は、S_OK が返されます。 それ以外の場合は、エラー コードが返されます。HRESULT.

要件

クライアントの最小要件	Windows 7, Windows Vista SP2 および Windows Vista 用のプラットフォーム更新プログラム
サーバーの最小要件	Windows Server 2008 R2, Windows Server 2008 SP2 および Windows Server 2008 用のプラットフォーム更新プログラム
ヘッダー	Dwrite.h
ライブラリ	Dwrite.lib
DLL	Dwrite.dll

参照

IDWriteTextLayout