IUIAutomationTextRange::GetAttributeValue メソッド (uiautomationclient.h)

  • [アーティクル]

指定したテキスト属性の値をテキスト範囲全体で取得します。

構文

HRESULT GetAttributeValue(
  [in]          TEXTATTRIBUTEID attr,
  [out, retval] VARIANT         *value
);

パラメーター

[in] attr

型: TEXTATTRIBUTEID

テキスト属性の識別子。 テキスト属性 ID の一覧については、「 テキスト属性識別子」を参照してください。

[out, retval] value

型: VARIANT*

指定した属性の値を受け取ります。

戻り値

型: HRESULT

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

解説

このメソッドによって取得される値の型は 、attr パラメーターによって異なります。 たとえば、attr パラメーターを UIA_FontNameAttributeId に設定して GetAttributeValue を呼び出すと、テキスト範囲のフォント名を表す文字列が返されますが、attr が UIA_IsItalicAttributeId に設定された GetAttributeValue を呼び出すとブール値が返されます。

attr で指定された属性がサポートされていない場合、value パラメーターは IUIAutomation::ReservedNotSupportedValue プロパティと同等の値を受け取ります。

テキスト範囲には、特定の属性に対して複数の値を含めることができます。 たとえば、テキスト範囲に複数のフォントが含まれている場合、FontName 属性には複数の値が含まれます。 複数の値を持つ属性は、 混合属性と呼ばれます。 GetAttributeValue から取得した値と UIAutomation::ReservedMixedAttributeValue プロパティを比較することで、特定の属性が混合属性であるかどうかを判断できます。

GetAttributeValue メソッドは、テキストが非表示か表示かに関係なく、属性値を取得します。 IsHiddenAttributeId UIA_使用して、テキストの表示をチェックします。

要件

   
サポートされている最小のクライアント 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 を含む)

関連項目

IUIAutomationTextRange

UI オートメーションによるテキスト コンテンツのサポート