ScrollContentPresenter ScrollContentPresenter ScrollContentPresenter Class

Displays the content of a ScrollViewer control.

Syntax

Declaration

public sealed class ScrollContentPresenterpublic sealed class ScrollContentPresenterPublic NotInheritable Class ScrollContentPresenter
<ScrollContentPresenter .../>
-or-
<ScrollContentPresenter ...>
content
</ScrollContentPresenter>

Inheritance Hierarchy

Inherited Members

Inherited properties

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Tag
Tag
Tag
, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Inherited events

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Inherited methods

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Constructors summary

Initializes a new instance of the ScrollContentPresenter class.

Properties summary

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

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

Gets the vertical size of all the scrollable content.

Gets the horizontal size of all the scrollable content.

Gets the distance the content has been scrolled horizontally.

Gets or sets the ScrollViewer element that controls scrolling behavior.

Gets the distance the content has been scrolled vertically.

Gets the vertical size of the viewable content.

Gets the horizontal size of the viewable content.

Methods summary

Scrolls the ScrollContentPresenter content downward by one line.

Scrolls the ScrollContentPresenter content to the left by a predetermined amount.

Scrolls the ScrollContentPresenter content to the right by a predetermined amount.

Scrolls the ScrollContentPresenter content upward by one line.

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

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

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

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

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

Scrolls down within the content by one page.

Scrolls left within the content by one page.

Scrolls right within the content by one page.

Scrolls up within the content by one page.

Sets the distance the content has been scrolled horizontally.

Sets the distance the content has been scrolled vertically.

Constructors

  • ScrollContentPresenter()
    ScrollContentPresenter()
    ScrollContentPresenter()
    ScrollContentPresenter()

    Initializes a new instance of the ScrollContentPresenter class.

    public ScrollContentPresenter()public New()Public Sub New()public ScrollContentPresenter()

Properties

  • CanHorizontallyScroll
    CanHorizontallyScroll
    CanHorizontallyScroll
    CanHorizontallyScroll

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

    public bool CanHorizontallyScroll { get; set; }public bool CanHorizontallyScroll { get; set; }Public ReadWrite Property CanHorizontallyScroll As boolpublic bool CanHorizontallyScroll { get; set; }

    Property Value

    • bool
      bool
      bool

      true if scrolling is possible; otherwise, false.

    Remarks

    Note

    This property is not intended to be set in XAML. You can set the panel's Orientation property in XAML and optionally change the HorizontalScrollBarVisibility or VerticalScrollBarVisibility to change how scrolling works. This property can be changed in code. In some cases you will need to use VisualTreeHelper to access the panel. For example, when used in an ItemsPanel, there's no property that provides access to a ScrollContentPresenter within the panel.

  • CanVerticallyScroll
    CanVerticallyScroll
    CanVerticallyScroll
    CanVerticallyScroll

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

    public bool CanVerticallyScroll { get; set; }public bool CanVerticallyScroll { get; set; }Public ReadWrite Property CanVerticallyScroll As boolpublic bool CanVerticallyScroll { get; set; }

    Property Value

    • bool
      bool
      bool

      true if scrolling is possible; otherwise, false.

    Remarks

    Note

    This property is not intended to be set in XAML. You can set the panel's Orientation property in XAML and optionally change the HorizontalScrollBarVisibility or VerticalScrollBarVisibility to change how scrolling works. This property can be changed in code. In some cases you will need to use VisualTreeHelper to access the panel. For example, when used in an ItemsPanel, there's no property that provides access to a ScrollContentPresenter within the panel.

  • ExtentHeight
    ExtentHeight
    ExtentHeight
    ExtentHeight

    Gets the vertical size of all the scrollable content.

    public double ExtentHeight { get; }public double ExtentHeight { get; }Public ReadOnly Property ExtentHeight As doublepublic double ExtentHeight { get; }

    Property Value

    • double
      double
      double

      The vertical size of the all scrollable content.

    Remarks

    The extent includes all the content in the ScrollViewer, whether visible or not. The viewport is the visible area of the content.

  • ExtentWidth
    ExtentWidth
    ExtentWidth
    ExtentWidth

    Gets the horizontal size of all the scrollable content.

    public double ExtentWidth { get; }public double ExtentWidth { get; }Public ReadOnly Property ExtentWidth As doublepublic double ExtentWidth { get; }

    Property Value

    • double
      double
      double

      The horizontal size of all the scrollable content.

    Remarks

    The extent includes all the content in the ScrollViewer, whether visible or not. The viewport is the visible area of the content.

  • HorizontalOffset
    HorizontalOffset
    HorizontalOffset
    HorizontalOffset

    Gets the distance the content has been scrolled horizontally.

    public double HorizontalOffset { get; }public double HorizontalOffset { get; }Public ReadOnly Property HorizontalOffset As doublepublic double HorizontalOffset { get; }

    Property Value

    • double
      double
      double

      The distance the content has been scrolled horizontally.

  • ScrollOwner
    ScrollOwner
    ScrollOwner
    ScrollOwner

    Gets or sets the ScrollViewer element that controls scrolling behavior.

    public object ScrollOwner { get; set; }public object ScrollOwner { get; set; }Public ReadWrite Property ScrollOwner As objectpublic object ScrollOwner { get; set; }

    Property Value

    • object
      object
      object

      The ScrollViewer element that controls scrolling behavior.

    Remarks

    This property is not intended to be set in XAML.

  • VerticalOffset
    VerticalOffset
    VerticalOffset
    VerticalOffset

    Gets the distance the content has been scrolled vertically.

    public double VerticalOffset { get; }public double VerticalOffset { get; }Public ReadOnly Property VerticalOffset As doublepublic double VerticalOffset { get; }

    Property Value

    • double
      double
      double

      The distance the content has been scrolled vertically.

  • ViewportHeight
    ViewportHeight
    ViewportHeight
    ViewportHeight

    Gets the vertical size of the viewable content.

    public double ViewportHeight { get; }public double ViewportHeight { get; }Public ReadOnly Property ViewportHeight As doublepublic double ViewportHeight { get; }

    Property Value

    • double
      double
      double

      The vertical size of the viewable content.

    Remarks

    The viewport includes all the visible content in the ScrollViewer.

  • ViewportWidth
    ViewportWidth
    ViewportWidth
    ViewportWidth

    Gets the horizontal size of the viewable content.

    public double ViewportWidth { get; }public double ViewportWidth { get; }Public ReadOnly Property ViewportWidth As doublepublic double ViewportWidth { get; }

    Property Value

    • double
      double
      double

      The horizontal size of the viewable content.

    Remarks

    The viewport includes all the visible content in the ScrollViewer.

Methods

  • LineDown()
    LineDown()
    LineDown()
    LineDown()

    Scrolls the ScrollContentPresenter content downward by one line.

    public void LineDown()public void LineDown()Public Function LineDown() As voidpublic void LineDown()
  • LineLeft()
    LineLeft()
    LineLeft()
    LineLeft()

    Scrolls the ScrollContentPresenter content to the left by a predetermined amount.

    public void LineLeft()public void LineLeft()Public Function LineLeft() As voidpublic void LineLeft()
  • LineRight()
    LineRight()
    LineRight()
    LineRight()

    Scrolls the ScrollContentPresenter content to the right by a predetermined amount.

    public void LineRight()public void LineRight()Public Function LineRight() As voidpublic void LineRight()
  • LineUp()
    LineUp()
    LineUp()
    LineUp()

    Scrolls the ScrollContentPresenter content upward by one line.

    public void LineUp()public void LineUp()Public Function LineUp() As voidpublic void LineUp()
  • MakeVisible(UIElement, Rect)
    MakeVisible(UIElement, Rect)
    MakeVisible(UIElement, Rect)
    MakeVisible(UIElement, Rect)

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

    public Rect MakeVisible(UIElement visual, Rect rectangle)public Rect MakeVisible(UIElement visual, Rect rectangle)Public Function MakeVisible(visual As UIElement, rectangle As Rect) As Rectpublic Rect MakeVisible(UIElement visual, Rect rectangle)

    Parameters

    Returns

    • A Rect that represents the visible region after scrolling happens.

  • MouseWheelDown()
    MouseWheelDown()
    MouseWheelDown()
    MouseWheelDown()

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

    public void MouseWheelDown()public void MouseWheelDown()Public Function MouseWheelDown() As voidpublic void MouseWheelDown()
  • MouseWheelLeft()
    MouseWheelLeft()
    MouseWheelLeft()
    MouseWheelLeft()

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

    public void MouseWheelLeft()public void MouseWheelLeft()Public Function MouseWheelLeft() As voidpublic void MouseWheelLeft()
  • MouseWheelRight()
    MouseWheelRight()
    MouseWheelRight()
    MouseWheelRight()

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

    public void MouseWheelRight()public void MouseWheelRight()Public Function MouseWheelRight() As voidpublic void MouseWheelRight()
  • MouseWheelUp()
    MouseWheelUp()
    MouseWheelUp()
    MouseWheelUp()

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

    public void MouseWheelUp()public void MouseWheelUp()Public Function MouseWheelUp() As voidpublic void MouseWheelUp()
  • PageDown()
    PageDown()
    PageDown()
    PageDown()

    Scrolls down within the content by one page.

    public void PageDown()public void PageDown()Public Function PageDown() As voidpublic void PageDown()
  • PageLeft()
    PageLeft()
    PageLeft()
    PageLeft()

    Scrolls left within the content by one page.

    public void PageLeft()public void PageLeft()Public Function PageLeft() As voidpublic void PageLeft()
  • PageRight()
    PageRight()
    PageRight()
    PageRight()

    Scrolls right within the content by one page.

    public void PageRight()public void PageRight()Public Function PageRight() As voidpublic void PageRight()
  • PageUp()
    PageUp()
    PageUp()
    PageUp()

    Scrolls up within the content by one page.

    public void PageUp()public void PageUp()Public Function PageUp() As voidpublic void PageUp()
  • SetHorizontalOffset(Double)
    SetHorizontalOffset(Double)
    SetHorizontalOffset(Double)
    SetHorizontalOffset(Double)

    Sets the distance the content has been scrolled horizontally.

    public void SetHorizontalOffset(Double offset)public void SetHorizontalOffset(Double offset)Public Function SetHorizontalOffset(offset As Double) As voidpublic void SetHorizontalOffset(Double offset)

    Parameters

    • offset
      System.Double
      System.Double
      System.Double

      The distance the content has been scrolled horizontally.

  • SetVerticalOffset(Double)
    SetVerticalOffset(Double)
    SetVerticalOffset(Double)
    SetVerticalOffset(Double)

    Sets the distance the content has been scrolled vertically.

    public void SetVerticalOffset(Double offset)public void SetVerticalOffset(Double offset)Public Function SetVerticalOffset(offset As Double) As voidpublic void SetVerticalOffset(Double offset)

    Parameters

    • offset
      System.Double
      System.Double
      System.Double

      The distance the content has been scrolled vertically.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Xaml.Controls.dll