TextPatternRange.GetText(Int32) Méthode

Définition

Espace de noms:

System.Windows.Automation.Text

Assembly:

UIAutomationClient.dll

Retourne le texte brut de la plage de texte.

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

public string GetText (int maxLength);

member this.GetText : int -> string

Public Function GetText (maxLength As Integer) As String

Paramètres

maxLength

Int32

Longueur maximale de la chaîne à retourner. Utilisez -1 si aucune limite n'est requise.

Retours

String

Texte brut de la plage de texte, éventuellement tronqué à la longueur maxLength spécifiée.

Exceptions

ArgumentOutOfRangeException

Si maxLength est inférieur à -1.

Exemples

 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

Remarques

GetText respecte à la fois le texte masqué et visible. Le client UI Automation peut case activée pour la visibilité du IsHiddenAttribute texte.

Si maxLength est supérieur à la longueur de l’étendue de texte de l’appelant, la chaîne retournée sera le texte brut de la plage de texte.

GetText ne sera pas affecté par l’ordre des points de terminaison dans le flux de texte ; il retourne toujours le texte entre les points de terminaison Début et Fin de la plage de texte dans l’ordre de flux de texte logique.

Voir aussi

• TextPatternRangeEndpoint