TextPatternRange.GetText(Int32) Método

Definição

Namespace:

System.Windows.Automation.Text

Assembly:

UIAutomationClient.dll

Retorna o texto sem formatação do intervalo de texto.

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

public string GetText (int maxLength);

member this.GetText : int -> string

Public Function GetText (maxLength As Integer) As String

Parâmetros

maxLength

Int32

O tamanho máximo da cadeia de caracteres a ser retornada. Use -1 se nenhum limite for necessário.

Retornos

String

O texto sem formatação do intervalo de texto, possivelmente truncado no maxLength especificado.

Exceções

ArgumentOutOfRangeException

Se maxLength for menor que -1.

Exemplos

 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

Comentários

GetText respeita o texto oculto e visível. O cliente de Automação da Interface do Usuário pode marcar o para visibilidade de IsHiddenAttribute texto.

Se maxLength for maior que o comprimento do intervalo de texto do chamador, a cadeia de caracteres retornada será o texto sem formatação do intervalo de texto.

GetText não será afetado pela ordem dos pontos de extremidade no fluxo de texto; ele sempre retornará o texto entre os pontos de extremidade Start e End do intervalo de texto na ordem de fluxo de texto lógico.

Confira também

• TextPatternRangeEndpoint