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

  • [アーティクル]

各テキスト範囲が表示されているテキストの連続したスパンを表すテキスト ベースのコントロールから、結合されていないテキスト範囲の配列を取得します。

構文

HRESULT GetVisibleRanges(
  [out, retval] SAFEARRAY **pRetVal
);

パラメーター

[out, retval] pRetVal

種類: SAFEARRAY**

表示されているテキスト範囲または空の配列の ITextRangeProvider インターフェイスへのポインターの配列のアドレスを受け取ります。 NULL 参照は返されません。 このパラメーターは初期化せずに渡されます。

戻り値

型: HRESULT

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

解説

表示されているテキストが 1 つの連続するテキスト範囲で構成されている場合、 pRetVal 配列には、表示されているすべてのテキストを表す単一のテキスト範囲が含まれている必要があります。

表示されるテキストが複数の非結合のテキストスパンで構成されている場合、 pRetVal 配列には、最初の表示スパンから始まり、最後の表示スパンで終わる、表示範囲ごとに 1 つのテキスト範囲が含まれている必要があります。 テキスト ベースのコントロールの内容が、重複するウィンドウやその他のオブジェクトによって部分的に隠れている場合、または複数のページまたは列を持つテキスト ベースのコントロールに、部分的にスクロールされたビュー外のコンテンツがある場合に、表示されるテキストの不整合が発生する可能性があります。

ITextProvider::GetVisibleRanges は、テキストが表示されていない場合、すべてのテキストが表示されない場合、またはテキストベースのコントロールにテキストが含まれない場合は、縮退 (空) のテキスト範囲を返す必要があります。

要件

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

関連項目

安全な配列を使用するためのベスト プラクティス

概念

ITextProvider

ITextRangeProvider

リファレンス

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