Interface IScrollInfo

Represents the main scrollable region inside a ScrollViewer control.

Namespace: System.Windows.Controls.Primitives

Assembly: OpenSilver.dll

Syntax

public interface IScrollInfo

Properties

CanHorizontallyScroll

Gets or sets a value that indicates whether scrolling on the horizontal axis is possible.

Declaration

bool CanHorizontallyScroll { get; set; }

Property Value

Type	Description
System.Boolean	true if scrolling is possible; otherwise false. This property has no default value.

CanVerticallyScroll

Gets or sets a value that indicates whether scrolling on the vertical axis is possible.

Declaration

bool CanVerticallyScroll { get; set; }

Property Value

Type	Description
System.Boolean	true if scrolling is possible; otherwise false. This property has no default value.

ExtentHeight

Gets the vertical size of the extent.

Declaration

double ExtentHeight { get; }

Property Value

Type	Description
System.Double	A System.Double that represents, in device independent pixels, the vertical size of the extent. This property has no default value.

ExtentWidth

Gets the horizontal size of the extent.

Declaration

double ExtentWidth { get; }

Property Value

Type	Description
System.Double	A System.Double that represents, in device independent pixels, the horizontal size of the extent. This property has no default value.

HorizontalOffset

Gets the horizontal offset of the scrolled content.

Declaration

double HorizontalOffset { get; }

Property Value

Type	Description
System.Double	A System.Double that represents, in device independent pixels, the horizontal offset. Valid values are between zero and the ExtentWidth minus the ViewportWidth. This property has no default value.

ScrollOwner

Gets or sets a ScrollViewer element that controls scrolling behavior.

Declaration

ScrollViewer ScrollOwner { get; set; }

Property Value

Type	Description
ScrollViewer	A ScrollViewer element that controls scrolling behavior. This property has no default value.

VerticalOffset

Gets the vertical offset of the scrolled content.

Declaration

double VerticalOffset { get; }

Property Value

Type	Description
System.Double	A System.Double that represents, in device independent pixels, the vertical offset of the scrolled content. Valid values are between zero and the ExtentHeight minus the ViewportHeight. This property has no default value.

ViewportHeight

Gets the vertical size of the viewport for this content.

Declaration

double ViewportHeight { get; }

Property Value

Type	Description
System.Double	A System.Double that represents, in device independent pixels, the vertical size of the viewport for this content. This property has no default value.

ViewportWidth

Gets the horizontal size of the viewport for this content.

Declaration

double ViewportWidth { get; }

Property Value

Type	Description
System.Double	A System.Double that represents, in device independent pixels, the horizontal size of the viewport for this content. This property has no default value.

Methods

LineDown()

Scrolls down within the content by one logical unit.

Declaration

void LineDown()

LineLeft()

Scrolls left within the content by one logical unit.

Declaration

void LineLeft()

LineRight()

Scrolls right within the content by one logical unit.

Declaration

void LineRight()

LineUp()

Scrolls up within the content by one logical unit.

Declaration

void LineUp()

MakeVisible(UIElement, Rect)

Forces content to scroll until the coordinate space of a visual object is visible.

Declaration

Rect MakeVisible(UIElement visual, Rect rectangle)

Parameters

Type	Name	Description
UIElement	visual	A UIElement that becomes visible.
Rect	rectangle	A bounding rectangle that identifies the coordinate space to make visible.

Returns

Type	Description
Rect	A Rect that is visible.

MouseWheelDown()

Scrolls down within the content after the user clicks the wheel button on a mouse.

Declaration

void MouseWheelDown()

MouseWheelLeft()

Scrolls left within the content after the user clicks the wheel button on a mouse.

Declaration

void MouseWheelLeft()

MouseWheelRight()

Scrolls right within the content after the user clicks the wheel button on a mouse.

Declaration

void MouseWheelRight()

MouseWheelUp()

Scrolls up within the content after the user clicks the wheel button on a mouse.

Declaration

void MouseWheelUp()

PageDown()

Scrolls down within the content by one page.

Declaration

void PageDown()

PageLeft()

Scrolls left within the content by one page.

Declaration

void PageLeft()

PageRight()

Scrolls right within the content by one page.

Declaration

void PageRight()

PageUp()

Scrolls up within the content by one page.

Declaration

void PageUp()

SetHorizontalOffset(Double)

Sets the amount of horizontal offset.

Declaration

void SetHorizontalOffset(double offset)

Parameters

Type	Name	Description
System.Double	offset	The amount that content is horizontally offset from the containing viewport.

SetVerticalOffset(Double)

Sets the amount of vertical offset.

Declaration

void SetVerticalOffset(double offset)

Parameters

Type	Name	Description
System.Double	offset	The amount that content is vertically offset from the containing viewport.