TextPatternRange.GetText(Int32) Methode

Definitie

Naamruimte:
System.Windows.Automation.Text
Assembly:
UIAutomationClient.dll

Retourneert de tekst zonder opmaak van het tekstbereik.

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

Parameters

maxLength
Int32

De maximale lengte van de tekenreeks die moet worden geretourneerd. Gebruik -1 deze optie als er geen limiet is vereist.

Retouren

String

De tekst zonder opmaak van het tekstbereik, mogelijk afgekapt op de opgegeven maxLength.

Uitzonderingen

ArgumentOutOfRangeException

Als maxLength dit kleiner is dan -1.

Voorbeelden

 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

Opmerkingen

GetText respecteert zowel verborgen als zichtbare tekst. De UI Automation-client kan de IsHiddenAttribute controleren op tekstzichtbaarheid.

Als maxLength de tekenreeks groter is dan de lengte van de tekstspanne van de aanroeper, wordt de geretourneerde tekenreeks de tekst zonder opmaak van het tekstbereik.

GetText wordt niet beïnvloed door de volgorde van eindpunten in de tekststroom; Deze retourneert altijd de tekst tussen de begin- en eindeindpunten van het tekstbereik in de volgorde van de logische tekststroom.

Van toepassing op

Zie ook