ITextRangeProvider::FindAttribute method

Returns a text range subset that has the specified text attribute value.

Syntax

HRESULT FindAttribute(
  TEXTATTRIBUTEID    attributeId,
  VARIANT            val,
  BOOL               backward,
  ITextRangeProvider **pRetVal
);

Parameters

attributeId

Type: TEXTATTRIBUTEID

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

val

Type: VARIANT

The attribute value to search for. This value must match the type specified for the attribute.

backward

Type: BOOL

TRUE if the last occurring text range should be returned instead of the first; otherwise FALSE.

pRetVal

Type: ITextRangeProvider**

Receives a pointer to the text range having a matching attribute and attribute value; otherwise NULL.

Return Value

Type: HRESULT

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

Remarks

The FindAttribute method retrieves matching text regardless of whether the text is hidden or visible. Clients can use UIA_IsHiddenAttributeId to check text visibility.

Requirements

   
Minimum supported client Windows XP [desktop apps | UWP apps]
Minimum supported server Windows Server 2003 [desktop apps | UWP apps]
Target Platform Windows
Header uiautomationcore.h (include UIAutomation.h)

See Also

Conceptual

ITextProvider

ITextRangeProvider

Reference

UI Automation Providers Overview