TextPatternRange.ScrollIntoView(Boolean) Methode

Definition

Namespace:

System.Windows.Automation.Text

Assembly:

UIAutomationClient.dll

Bewirkt, dass im Textsteuerelement ein vertikaler Bildlauf durchgeführt wird, bis der Textbereich im Anzeigebereich sichtbar ist.

public:
 void ScrollIntoView(bool alignToTop);

public void ScrollIntoView (bool alignToTop);

member this.ScrollIntoView : bool -> unit

Public Sub ScrollIntoView (alignToTop As Boolean)

Parameter

alignToTop

Boolean

true, wenn im Textsteuerelement ein Bildlauf so durchgeführt werden soll, dass der Textbereich am oberen Rand des Anzeigebereichs ausgerichtet ist, false, wenn der Bereich am unteren Rand des Anzeigebereichs ausgerichtet werden soll.

Ausnahmen

InvalidOperationException

Wenn Bildläufe vom Steuerelement nicht unterstützt werden.

Beispiele

private void ScrollToSelection(AutomationElement target)
{
    // 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;
    }
    TextPatternRange[] currentSelection = textpatternPattern.GetSelection();

    currentSelection[0].ScrollIntoView(true);
}

Private Sub ScrollToSelection(ByVal target As AutomationElement)
    ' 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
    End If
    Dim currentSelection As TextPatternRange() = textpatternPattern.GetSelection()
    currentSelection(0).ScrollIntoView(True)
End Sub

Hinweise

ScrollIntoView berücksichtigt sowohl ausgeblendeten als auch sichtbaren Text. Der Benutzeroberflächenautomatisierungsclient kann die IsHiddenAttribute auf Textsichtbarkeit überprüfen. Wenn der Textbereich ausgeblendet ist, scrollt das Textsteuerelement nur dann, wenn der ausgeblendete Text über einen Anker im Viewport verfügt.