TextPatternRange.GetText(Int32) Metod

Definition

Namnområde:
System.Windows.Automation.Text
Sammansättning:
UIAutomationClient.dll

Returnerar oformaterad text i textområdet.

public:
 System::String ^ GetText(int maxLength);
public string GetText(int maxLength);
member this.GetText : int -> string
Public Function GetText (maxLength As Integer) As String

Parametrar

maxLength
Int32

Den maximala längden på strängen som ska returneras. Använd -1 om ingen gräns krävs.

Returer

String

Oformaterad text i textområdet, eventuellt trunkerad vid angiven maxLength.

Undantag

ArgumentOutOfRangeException

Om maxLength är mindre än -1.

Exempel

 private String TextFromSelection(AutomationElement target, Int32 length)
{
    // 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();

    // GetText(-1) retrieves all characters but can be inefficient
    return currentSelection[0].GetText(length);
}

Private Function TextFromSelection(ByVal target As AutomationElement, ByVal length As Int32) As String
    ' 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()
    ' GetText(-1) retrieves all characters but can be inefficient
    Return currentSelection(0).GetText(length)
End Function

Kommentarer

GetText respekterar både dold och synlig text. UI Automation-klienten kan kontrollera IsHiddenAttribute för textsynlighet.

Om maxLength är större än längden på textintervallet för anroparen blir strängen som returneras den oformaterade texten i textområdet.

GetText påverkas inte av ordningen på slutpunkter i textflödet. Den returnerar alltid texten mellan start- och slutpunkterna för textintervallet i den logiska textflödesordningen.

Gäller för

Se även