Article
11/18/2011

ITextRangeProvider.CompareEndpoints Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Namespace: System.Windows.Automation.Provider
Assembly: System.Windows (in System.Windows.dll)

Syntax

'Declaration
Function CompareEndpoints ( _
    endpoint As TextPatternRangeEndpoint, _
    targetRange As ITextRangeProvider, _
    targetEndpoint As TextPatternRangeEndpoint _
) As Integer

int CompareEndpoints(
    TextPatternRangeEndpoint endpoint,
    ITextRangeProvider targetRange,
    TextPatternRangeEndpoint targetEndpoint
)

Parameters

endpoint
Type: System.Windows.Automation.Text.TextPatternRangeEndpoint
The Start or End endpoint of the caller.

targetRange
Type: System.Windows.Automation.Provider.ITextRangeProvider
The target range for comparison.

targetEndpoint
Type: System.Windows.Automation.Text.TextPatternRangeEndpoint
The Start or End endpoint of the target.

Return Value

Type: System.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

Exception	Condition
ArgumentException	The targetRange is from a different text provider.

Version Information

Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.