TextPatternRange.ScrollIntoView(Boolean) メソッド

定義

名前空間:

System.Windows.Automation.Text

アセンブリ:

UIAutomationClient.dll

テキスト範囲がビューポート内に表示されるまで、テキスト コントロールを垂直方向にスクロールします。

public:
 void ScrollIntoView(bool alignToTop);

public void ScrollIntoView (bool alignToTop);

member this.ScrollIntoView : bool -> unit

Public Sub ScrollIntoView (alignToTop As Boolean)

パラメーター

alignToTop

Boolean

テキスト範囲をスクロールしてビューポートの上辺と揃える場合は true。ビューポートの底辺と揃える場合は false

例外

InvalidOperationException

スクロールがコントロールでサポートされていない場合。

例

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

注釈

ScrollIntoView は、非表示のテキストと表示されるテキストの両方を尊重します。 UI オートメーション クライアントでは、 をチェックしてIsHiddenAttributeテキストを表示できます。 テキスト範囲が非表示の場合、テキスト コントロールは、非表示のテキストにビューポートにアンカーがある場合にのみスクロールします。