IViewScroller Interface

Definition

Namespace:

Microsoft.VisualStudio.Text.Editor

Assembly:

Microsoft.VisualStudio.Text.UI.dll

Represents a helper class for the ITextView, and provides basic functionality for scrolling. The ViewScroller property of ITextView is used to get an instance of the this interface.

public interface class IViewScroller

public interface class IViewScroller

__interface IViewScroller

public interface IViewScroller

type IViewScroller = interface

Public Interface IViewScroller

Remarks

Most properties and parameters that are doubles correspond to coordinates or distances in the text rendering coordinate system. In this coordinate system, x = 0.0 corresponds to the left edge of the drawing surface onto which text is rendered (x = view.ViewportLeft corresponds to the left edge of the viewport), and y = view.ViewportTop corresponds to the top edge of the viewport. The x-coordinate increases from left to right, and the y-coordinate increases from top to bottom.

The horizontal and vertical axes of the view behave differently. When the text in the view is formatted, only the visible lines are formatted. As a result, a viewport cannot be scrolled horizontally and vertically in the same way.

A viewport is scrolled horizontally by changing the left coordinate of the viewport so that it moves with respect to the drawing surface.

A view can be scrolled vertically only by performing a new layout.

Doing a layout in the view may cause the ViewportTop property of the view to change. For example, scrolling down one line will not translate any of the visible lines. Instead it will simply change the view's ViewportTop property (causing the lines to move on the screen even though their y-coordinates have not changed).

Distances in the text rendering coordinate system correspond to logical pixels. If the text rendering surface is displayed without any scaling transform, then 1 unit in the text rendering coordinate system corresponds to one pixel on the display.

Methods

EnsureSpanVisible(SnapshotSpan)	Ensures that all the text in span is entirely visible in the view.
EnsureSpanVisible(SnapshotSpan, EnsureSpanVisibleOptions)	Ensures that all the text in span is entirely visible in the view.
EnsureSpanVisible(VirtualSnapshotSpan, EnsureSpanVisibleOptions)	Ensures that all the text in span is entirely visible in the view.
ScrollViewportHorizontallyByPixels(Double)	Scrolls the viewport horizontally by distanceToScroll.
ScrollViewportVerticallyByLine(ScrollDirection)	Scrolls the viewport vertically one line up or down.
ScrollViewportVerticallyByLines(ScrollDirection, Int32)	Scrolls the viewport vertically by multiple lines up or down.
ScrollViewportVerticallyByPage(ScrollDirection)	Scrolls the viewport vertically one page up or down.
ScrollViewportVerticallyByPixels(Double)	Scrolls the viewport vertically by distanceToScroll.