TextPatternRange.GetText(Int32) Metoda

Definice

Obor názvů:

System.Windows.Automation.Text

Sestavení:

UIAutomationClient.dll

Vrátí prostý text oblasti textu.

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

public string GetText (int maxLength);

member this.GetText : int -> string

Public Function GetText (maxLength As Integer) As String

Parametry

maxLength

Int32

Maximální délka řetězce, který se má vrátit. Použijte -1 , pokud není vyžadován žádný limit.

Návraty

String

Prostý text rozsahu textu, pravděpodobně zkrácený v zadaném maxLengthobjektu .

Výjimky

ArgumentOutOfRangeException

Pokud maxLength je menší než -1.

Příklady

 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

Poznámky

GetText respektuje skrytý i viditelný text. Klient automatizace uživatelského rozhraní může zkontrolovat IsHiddenAttribute viditelnost textu.

Pokud maxLength je větší než délka rozsahu textu volajícího, vrácený řetězec bude prostým textem rozsahu textu.

GetText nebude ovlivněno pořadím koncových bodů v toku textu; vždy vrátí text mezi počátečními a koncovými body oblasti textu v pořadí logického toku textu.

Viz také

• TextPatternRangeEndpoint