ITextProvider.GetSelection Method

Definition

Namespace:

System.Windows.Automation.Provider

Assembly:

UIAutomationProvider.dll

Retrieves a collection of disjoint text ranges associated with the current text selection or selections.

public:
 cli::array <System::Windows::Automation::Provider::ITextRangeProvider ^> ^ GetSelection();

public System.Windows.Automation.Provider.ITextRangeProvider[] GetSelection ();

abstract member GetSelection : unit -> System.Windows.Automation.Provider.ITextRangeProvider[]

Public Function GetSelection () As ITextRangeProvider()

Returns

ITextRangeProvider[]

A collection of disjoint text ranges.

Exceptions

InvalidOperationException

If the UI Automation provider does not support text selection.

Remarks

For UI Automation providers that support text selection, the provider should implement this method and also return a SupportedTextSelection value.

If no text is selected, GetSelection returns the degenerate text range (empty range) at the position of the system cursor (text insertion point).

If the system cursor (text insertion point) is not present, GetSelection may return a null reference (Nothing in Visual Basic).

See also

• ITextRangeProvider