ITextRangeProvider::MoveEndpointByUnit メソッド (uiautomationcore.h)

テキスト範囲の 1 つのエンドポイントを、指定した数のテキストユニット ドキュメント範囲内の単位 移動します。

構文

HRESULT MoveEndpointByUnit(
  [in]          TextPatternRangeEndpoint endpoint,
  [in]          TextUnit                 unit,
  [in]          int                      count,
  [out, retval] int                      *pRetVal
);

パラメーター

[in] endpoint

型: TextPatternRangeEndpoint

移動するエンドポイント。

[in] unit

型: TextUnit

文字、単語、段落などのテキスト単位の種類。

[in] count

型: int

移動する単位の数。 正の値を指定すると、エンドポイントが前方に移動します。 負の値は後方に移動します。 値 0 は影響しません。

[out, retval] pRetVal

型: int*

実際に移動された単位数を受け取ります。これは、エンドポイントの移動がドキュメントの先頭または末尾に実行される場合に要求された数より小さい場合があります。

戻り値

型: HRESULT

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

備考

エンドポイント は、指定されたとおり、次に使用可能なユニット境界に前後に移動されます。 元の エンドポイント が指定したテキスト単位の境界にあった場合、次の図に示すように、エンドポイント は次に使用可能なテキスト単位の境界に移動されます。

移動するテキスト範囲のエンドポイントを示す図 エンドポイント が同じテキスト範囲の他の エンドポイント を越えた場合、他の エンドポイント も移動され、結果として、エンドポイント の正しい順序が保証されます (つまり、開始が常に終了以下である)。

ITextRangeProvider::MoveEndpointByUnit、指定されたテキストユニットがコントロールでサポートされていない場合、次にサポートされるテキストユニットまで非推奨になります。

最小単位から最大値までの順序を次に示します。

  • 文字
  • 書式
  • Word の
  • 段落 を する
  • ページ
  • ドキュメント の

単位 が されている場合 範囲の動作

単位として TextUnit::Format 値は、範囲内のテキストの共有テキスト属性 (書式) に基づいて範囲を展開または移動するために、テキスト範囲の境界を配置します。 ただし、テキストの書式設定単位を使用して、画像やハイパーリンクなどの埋め込みオブジェクトの境界を越えてテキスト範囲を移動または展開しないでください。 詳細については、「UI オートメーションテキストユニット または テキストおよび TextRange コントロール パターンを参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows XP [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー Windows Server 2003 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー uiautomationcore.h (UIAutomation.h を含む)

関連項目

概念

ITextProvider の

ITextRangeProvider の

リファレンス

Text および TextRange コントロール パターン

UI オートメーション プロバイダーの概要