TextPatternRange.Compare(TextPatternRange) Method
Definition
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.
public:
bool Compare(System::Windows::Automation::Text::TextPatternRange ^ range);
public bool Compare (System.Windows.Automation.Text.TextPatternRange range);
member this.Compare : System.Windows.Automation.Text.TextPatternRange -> bool
Public Function Compare (range As TextPatternRange) As Boolean
Parameters
- range
- TextPatternRange
A text range to compare.
Returns
true
if the span of both text ranges is identical; otherwise false
.
Exceptions
If the range being compared does not come from the same text provider.
Examples
private Boolean CompareRanges(AutomationElement target)
{
// Specify the control type we're looking for, in this case 'Document'
PropertyCondition cond = new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Document);
// target --> The root AutomationElement.
AutomationElement textProvider = target.FindFirst(TreeScope.Descendants, cond);
TextPattern textpatternPattern = textProvider.GetCurrentPattern(TextPattern.Pattern) as TextPattern;
if (textpatternPattern == null)
{
Console.WriteLine("Root element does not contain a descendant that supports TextPattern.");
return false;
}
TextPatternRange[] currentSelection = textpatternPattern.GetSelection();
TextPatternRange[] currentVisibleRanges = textpatternPattern.GetVisibleRanges();
return currentSelection[0].Compare(currentVisibleRanges[0]);
}
Private Function CompareRanges(ByVal target As AutomationElement) As Boolean
' Specify the control type we're looking for, in this case 'Document'
Dim cond As PropertyCondition = New PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Document)
' target --> The root AutomationElement.
Dim textProvider As AutomationElement = target.FindFirst(TreeScope.Descendants, cond)
Dim textpatternPattern As TextPattern = CType(textProvider.GetCurrentPattern(TextPattern.Pattern), TextPattern)
If (textpatternPattern Is Nothing) Then
Console.WriteLine("Root element does not contain a descendant that supports TextPattern.")
Return Nothing
End If
Dim currentSelection As TextPatternRange() = textpatternPattern.GetSelection()
Dim currentVisibleRange As TextPatternRange() = textpatternPattern.GetVisibleRanges()
Return currentSelection(0).Compare(currentVisibleRange(0))
End Function