ITextProvider2::RangeFromAnnotation method

Exposes a text range that contains the text that is the target of the annotation associated with the specified annotation element.

Syntax


HRESULT RangeFromAnnotation(
  [in]           IRawElementProviderSimple *annotationElement,
  [out, retval]  ITextRangeProvider **pRetVal
);

Parameters

annotationElement [in]

Type: IRawElementProviderSimple*

The provider for an element that implements the IAnnotationProvider interface. The annotation element is a sibling of the element that implements the ITextProvider2 interface for the document.

pRetVal [out, retval]

Type: ITextRangeProvider**

Receives a text range that contains the annotation target text.

Return value

Type: HRESULT

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

Requirements

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

UIAutomationCore.h (include UIAutomation.h)

IDL

UIAutomationCore.idl

See also

ITextProvider2
ITextProvider
Document Control Type
UI Automation Providers Overview
UI Automation Support for Textual Content

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.