TextPatternRange.GetText(Int32) Metode

Definisi

Ruang nama:

System.Windows.Automation.Text

Rakitan:

UIAutomationClient.dll

Mengembalikan teks biasa dari rentang teks.

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

Panjang maksimum string yang akan dikembalikan. Gunakan -1 jika tidak ada batasan yang diperlukan.

Mengembalikan

String

Teks biasa dari rentang teks, mungkin terpotok pada yang ditentukan maxLength.

Pengecualian

ArgumentOutOfRangeException

Jika maxLength kurang dari -1.

Contoh

 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

Keterangan

GetText menghormati teks tersembunyi dan terlihat. Klien Automation UI dapat memeriksa IsHiddenAttribute visibilitas teks.

Jika maxLength lebih besar dari panjang rentang teks pemanggil, string yang dikembalikan akan menjadi teks biasa dari rentang teks.

GetText tidak akan terpengaruh oleh urutan titik akhir dalam aliran teks; ini akan selalu mengembalikan teks antara titik akhir Mulai dan Akhir dari rentang teks dalam urutan aliran teks logis.

Lihat juga

• TextPatternRangeEndpoint