IViewScroller.ScrollViewportVerticallyByPage(ScrollDirection) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

Assembly:: Microsoft.VisualStudio.Text.UI.dll

Package:: Microsoft.VisualStudio.Text.UI v17.12.215

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Scrolls the viewport vertically one page up or down.

public:
 bool ScrollViewportVerticallyByPage(Microsoft::VisualStudio::Text::Editor::ScrollDirection direction);

public:
 bool ScrollViewportVerticallyByPage(Microsoft::VisualStudio::Text::Editor::ScrollDirection direction);

bool ScrollViewportVerticallyByPage(Microsoft::VisualStudio::Text::Editor::ScrollDirection direction);

public bool ScrollViewportVerticallyByPage (Microsoft.VisualStudio.Text.Editor.ScrollDirection direction);

abstract member ScrollViewportVerticallyByPage : Microsoft.VisualStudio.Text.Editor.ScrollDirection -> bool

Public Function ScrollViewportVerticallyByPage (direction As ScrollDirection) As Boolean

Parameters

direction: ScrollDirection

The direction in which to scroll.

Returns

Boolean

true if the view was scrolled by a full page. false if the view had been positioned near the top/bottom of the document and, as a result, scrolled by less than the height of the viewport.

Exceptions

ArgumentOutOfRangeException

direction is not a ScrollDirection.

Remarks

The view will be scrolled by the height of the viewport minus whatever is needed to have the first line of the viewport be flush with the top of the view.

The view cannot be scrolled so that there is a gap between the top of the view and the first line of text.

The view cannot be scrolled the last line of the buffer is above the top of the view.

Applies to

Freigeben über