ITextProvider::RangeFromChild メソッド (uiautomationcore.h)

  • [アーティクル]

指定した子要素 (画像、ハイパーリンク、その他の埋め込みオブジェクトなど) を囲むテキスト範囲を取得します。

構文

HRESULT RangeFromChild(
  [in]          IRawElementProviderSimple *childElement,
  [out, retval] ITextRangeProvider        **pRetVal
);

パラメーター

[in] childElement

種類: IRawElementProviderSimple*

指定した子要素のUI オートメーション プロバイダー。

[out, retval] pRetVal

種類: ITextRangeProvider**

子要素を囲むテキスト範囲。

この範囲は、子要素の内容を完全に囲み、次のようにします。

  1. ITextRangeProvider::GetEnclosingElement は、子要素自体、または子要素と同じテキスト範囲を共有する子要素の最も内側の子孫を返します
  2. ITextRangeProvider::GetChildren は、範囲内で完全に囲まれた (1) から要素の子を返します
  3. 範囲の両方のエンドポイントが子要素の境界にあります

このパラメーターは初期化せずに渡されます。

戻り値

型: HRESULT

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

注意

childElement が ITextProvider の子孫ではない場合、または有効なテキスト範囲で囲まれていない場合は、E_INVALIDARGが返されます。

注釈

ITextRangeProvider::GetChildren で取得された各要素には、RangeFromChild を使用して取得できる有効なテキスト範囲もあります。 これには、ITextProvider と子要素の間のUI オートメーション ツリー内の要素が含まれます。

例

  1. この例では、画像リンクを含むテキスト ストリームを示します。 リンクはイメージの子ですが、どちらも同じテキスト範囲にまたがり、テキスト ストリーム内の埋め込みオブジェクトとして公開されます。

    Hello <Image Link> World

  2. この例では、テキストで囲まれた 2 セルのテーブルを含むテキスト ストリームを示します。

    テキストの開始

    表のセル 1表のセル 2

    テキストの終了

要件

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

こちらもご覧ください

ITextProvider、ITextRangeProvider、ITextRangeProvider::GetEnclosingElement、ITextRangeProvider::GetChildren、UI オートメーション プロバイダーの概要