TextPatternRange.GetText(Int32) Methode

Definition

Namespace:

System.Windows.Automation.Text

Assembly:

UIAutomationClient.dll

Gibt den reinen Text des Textbereichs zurück.

public:
 System::String ^ GetText(int maxLength);

public string GetText (int maxLength);

member this.GetText : int -> string

Public Function GetText (maxLength As Integer) As String

Parameter

maxLength

Int32

Die maximale Länge der zurückzugebenden Zeichenfolge. Verwenden Sie -1 , wenn keine Grenze erforderlich ist.

Gibt zurück

String

Der reine Text des Textbereichs, möglicherweise an der angegebenen maxLength abgeschnitten.

Ausnahmen

ArgumentOutOfRangeException

Wenn maxLength kleiner als -1 ist.

Beispiele

 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

Hinweise

GetText berücksichtigt ausgeblendeten und sichtbaren Text. Der Benutzeroberflächenautomatisierungsclient kann die IsHiddenAttribute auf Textsichtbarkeit überprüfen.

Wenn maxLength größer als die Länge der Textspanne des Aufrufers ist, ist die zurückgegebene Zeichenfolge der Nur-Text des Textbereichs.

GetText wird von der Reihenfolge der Endpunkte im Textfluss nicht beeinflusst; Es gibt immer den Text zwischen den Endpunkten Start und Ende des Textbereichs in der logischen Textflussreihenfolge zurück.

Weitere Informationen

• TextPatternRangeEndpoint