Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 5.05 KB

nf-uiautomationclient-iuiautomationtextrange-getattributevalue.md

File metadata and controls

97 lines (69 loc) · 5.05 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:uiautomationclient.IUIAutomationTextRange.GetAttributeValue
IUIAutomationTextRange::GetAttributeValue (uiautomationclient.h)
Retrieves the value of the specified text attribute across the entire text range.
GetAttributeValue
GetAttributeValue method [Windows Accessibility]
GetAttributeValue method [Windows Accessibility]
IUIAutomationTextRange interface
IUIAutomationTextRange interface [Windows Accessibility]
GetAttributeValue method
IUIAutomationTextRange.GetAttributeValue
IUIAutomationTextRange::GetAttributeValue
uiauto.uiauto_IUIAutomationTextRange_GetAttributeValue
uiauto_IUIAutomationTextRange_GetAttributeValue
uiautomationclient/IUIAutomationTextRange::GetAttributeValue
winauto.uiauto_IUIAutomationTextRange_GetAttributeValue
winauto\uiauto_IUIAutomationTextRange_GetAttributeValue.htm
WinAuto
7a77774e-7be0-473e-a0c9-e1aa108549e1
12/05/2018
GetAttributeValue, GetAttributeValue method [Windows Accessibility], GetAttributeValue method [Windows Accessibility],IUIAutomationTextRange interface, IUIAutomationTextRange interface [Windows Accessibility],GetAttributeValue method, IUIAutomationTextRange.GetAttributeValue, IUIAutomationTextRange::GetAttributeValue, uiauto.uiauto_IUIAutomationTextRange_GetAttributeValue, uiauto_IUIAutomationTextRange_GetAttributeValue, uiautomationclient/IUIAutomationTextRange::GetAttributeValue, winauto.uiauto_IUIAutomationTextRange_GetAttributeValue
uiautomationclient.h
UIAutomation.h
Windows
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista, Windows XP with SP3 and Platform Update for Windows Vista [desktop apps only]
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008, Windows Server 2003 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]
UIAutomationClient.idl
Windows
19H1
IUIAutomationTextRange::GetAttributeValue
uiautomationclient/IUIAutomationTextRange::GetAttributeValue
c++
APIRef
kbSyntax
COM
UIAutomationClient.h
IUIAutomationTextRange.GetAttributeValue

IUIAutomationTextRange::GetAttributeValue

-description

Retrieves the value of the specified text attribute across the entire text range.

-parameters

-param attr [in]

Type: TEXTATTRIBUTEID

The identifier of the text attribute. For a list of text attribute IDs, see Text Attribute Identifiers.

-param value [out, retval]

Type: VARIANT*

Receives the value of the specified attribute.

-returns

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

-remarks

The type of value retrieved by this method depends on the attr parameter. For example, calling GetAttributeValue with the attr parameter set to UIA_FontNameAttributeId returns a string that represents the font name of the text range, while calling GetAttributeValue with attr set to UIA_IsItalicAttributeId would return a boolean.

If the attribute specified by attr is not supported, the value parameter receives a value that is equivalent to the IUIAutomation::ReservedNotSupportedValue property.

A text range can include more than one value for a particular attribute. For example, if a text range includes more than one font, the FontName attribute will have multiple values. An attribute with more than one value is called a mixed attribute. You can determine if a particular attribute is a mixed attribute by comparing the value retrieved from GetAttributeValue with the UIAutomation::ReservedMixedAttributeValue property.

The GetAttributeValue method retrieves the attribute value regardless of whether the text is hidden or visible. Use UIA_ IsHiddenAttributeId to check text visibility.

-see-also

IUIAutomationTextRange

UI Automation Support for Textual Content