ITextRangeProvider.CompareEndpoints Method

Definition

Namespace:

System.Windows.Automation.Provider

Assembly:

UIAutomationTypes.dll

Returns a value that specifies whether two text ranges have identical endpoints.

public:
 int CompareEndpoints(System::Windows::Automation::Text::TextPatternRangeEndpoint endpoint, System::Windows::Automation::Provider::ITextRangeProvider ^ targetRange, System::Windows::Automation::Text::TextPatternRangeEndpoint targetEndpoint);

public int CompareEndpoints (System.Windows.Automation.Text.TextPatternRangeEndpoint endpoint, System.Windows.Automation.Provider.ITextRangeProvider targetRange, System.Windows.Automation.Text.TextPatternRangeEndpoint targetEndpoint);

abstract member CompareEndpoints : System.Windows.Automation.Text.TextPatternRangeEndpoint * System.Windows.Automation.Provider.ITextRangeProvider * System.Windows.Automation.Text.TextPatternRangeEndpoint -> int

Public Function CompareEndpoints (endpoint As TextPatternRangeEndpoint, targetRange As ITextRangeProvider, targetEndpoint As TextPatternRangeEndpoint) As Integer

Parameters

endpoint

TextPatternRangeEndpoint

The Start or End endpoint of the caller.

targetRange

ITextRangeProvider

The target range for comparison.

targetEndpoint

TextPatternRangeEndpoint

The Start or End endpoint of the target.

Returns

Int32

Returns a negative value if the caller's endpoint occurs earlier in the text than the target endpoint.

Returns zero if the caller's endpoint is at the same location as the target endpoint.

Returns a positive value if the caller's endpoint occurs later in the text than the target endpoint.

Exceptions

ArgumentException

If targetRange is from a different text provider.