IUIAutomationTextRange::ExpandToEnclosingUnit メソッド (uiautomationclient.h)
指定したテキスト単位でテキスト範囲を正規化します。 指定した単位より小さい場合は範囲が拡張され、指定した単位より長い場合は短縮されます。
構文
HRESULT ExpandToEnclosingUnit(
[in] TextUnit textUnit
);
パラメーター
[in] textUnit
型: TextUnit
行や段落などのテキスト単位。
戻り値
型: HRESULT
このメソッドは、成功すると S_OK を返します。 成功しなかった場合は、HRESULT エラー コードを返します。
解説
スクリーン リーダーなどのクライアント アプリケーションでは、このメソッドを使用して、カーソル位置またはキャレット位置に存在する完全な単語、文、または段落を取得します。
名前にもかかわらず、ExpandToEnclosingUnit メソッドは必ずしもテキスト範囲を展開するとは限りません。 代わりに、エンドポイントを移動してテキスト範囲を "正規化" し、指定したテキスト単位が範囲に含まれるようにします。 指定した単位より小さい場合は範囲が拡張され、指定した単位より長い場合は短縮されます。 指定した単位の正確な数量が既に範囲である場合は、変更されません。 次の図は、ExpandToEnclosingUnit が範囲のエンドポイントを移動してテキスト範囲を正規化する方法を示しています。
ExpandToEnclosingUnit の前後のエンドポイントを示す図
ExpandToEnclosingUnit は、指定したテキスト単位がコントロールでサポートされていない場合、既定でサポートされる次の最大テキスト単位に設定されます。
最小単位から最大までの順序は次のとおりです。
- 文字
- 形式
- Word
- 行
- 段落
- Page
- ドキュメント
ExpandToEnclosingUnit は、表示されるテキストと非表示のテキストの両方を考慮します。
unit が の場合の範囲の動作TextUnit::Format
TextUnit::Formatは 、テキスト 範囲の境界を単位値として配置し、範囲内のテキストの共有テキスト属性 (または書式) に基づいて範囲を展開または移動します。 ただし、テキスト単位は Format 、画像やハイパーリンクなど、埋め込みオブジェクトの境界を越えてテキスト範囲を移動または展開しません。 詳細については、「テキスト単位のUI オートメーション」または「テキストコンテンツのUI オートメーションサポート」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 7、Windows Vista SP2 と Windows Vista 用プラットフォーム更新プログラム、WINDOWS XP SP3 と Windows Vista 用プラットフォーム更新プログラム [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム、WINDOWS Server 2003 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | uiautomationclient.h (UIAutomation.h を含む) |