TextPatternRange.Clone Method

Reference

Definition

Namespace:: System.Windows.Automation.Text

Assembly:: UIAutomationClient.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 new TextPatternRange identical to the original TextPatternRange and inheriting all properties of the original.

public:
 System::Windows::Automation::Text::TextPatternRange ^ Clone();

public System.Windows.Automation.Text.TextPatternRange Clone ();

member this.Clone : unit -> System.Windows.Automation.Text.TextPatternRange

Public Function Clone () As TextPatternRange

Returns

TextPatternRange

The new text range. A null reference (Nothing in Visual Basic) is never returned.

Examples

private TextPatternRange CloneSelection(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 null;
    }
    TextPatternRange[] currentSelection = textpatternPattern.GetSelection();
    return currentSelection[0].Clone();
}

Private Function CloneSelection(ByVal target As AutomationElement) As TextPatternRange
    ' 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()
    Return currentSelection.Clone(0)
End Function

Remarks

Alternatively, create a new DocumentRange from the TextPattern and move the two endpoints to correspond with the endpoints of the original text range.

The new range can be manipulated independently from the original.

Applies to

Jaa