IViewScroller.ScrollViewportHorizontallyByPixels(Double) Method

Definition

Namespace:

Microsoft.VisualStudio.Text.Editor

Assembly:

Microsoft.VisualStudio.Text.UI.dll

Package:

Microsoft.VisualStudio.Text.UI v17.12.215

Scrolls the viewport horizontally by distanceToScroll.

public:
 void ScrollViewportHorizontallyByPixels(double distanceToScroll);

public:
 void ScrollViewportHorizontallyByPixels(double distanceToScroll);

void ScrollViewportHorizontallyByPixels(double distanceToScroll);

public void ScrollViewportHorizontallyByPixels (double distanceToScroll);

abstract member ScrollViewportHorizontallyByPixels : double -> unit

Public Sub ScrollViewportHorizontallyByPixels (distanceToScroll As Double)

Parameters

distanceToScroll

Double

The distance to scroll the viewport in the text rendering coordinate system. Positive values scroll the viewport to the right, and negative values scroll the viewport to the left.

Exceptions

ArgumentOutOfRangeException

distanceToScroll is NaN.

Remarks

A view cannot be scrolled horizontally if word wrap is enabled. If word wrap is disabled, the horizontal offset of the view must be between [0.0, max(0.0, formatted content width - viewport width)].