ITextProvider.RangeFromChild(IRawElementProviderSimple) Method

Reference

Definition

Namespace:: System.Windows.Automation.Provider

Assembly:: UIAutomationProvider.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves a text range enclosing a child element such as an image, hyperlink, or other embedded object.

public:
 System::Windows::Automation::Provider::ITextRangeProvider ^ RangeFromChild(System::Windows::Automation::Provider::IRawElementProviderSimple ^ childElement);

public System.Windows.Automation.Provider.ITextRangeProvider RangeFromChild (System.Windows.Automation.Provider.IRawElementProviderSimple childElement);

abstract member RangeFromChild : System.Windows.Automation.Provider.IRawElementProviderSimple -> System.Windows.Automation.Provider.ITextRangeProvider

Public Function RangeFromChild (childElement As IRawElementProviderSimple) As ITextRangeProvider

Parameters

childElement: IRawElementProviderSimple

The enclosed object.

Returns

ITextRangeProvider

A range that spans the child element.

Exceptions

ArgumentException

If the child element is a null reference (Nothing in Visual Basic).

Remarks

A UI Automation provider should check that the passed element is a child of the text container.

If there is no text in the range where the child element exists, a degenerate (empty) range is returned.

The childElement parameter is either a child of the AutomationElement associated with a TextPattern or from the array of children of a TextPatternRange.

Applies to