Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IScrollInfo Interface

Represents the main scrollable region inside a ScrollViewer control.

Namespace:  System.Windows.Controls.Primitives
Assembly:  PresentationFramework (in PresentationFramework.dll)

type IScrollInfo =  interface end

The IScrollInfo type exposes the following members.

  NameDescription
Public propertyCanHorizontallyScrollGets or sets a value that indicates whether scrolling on the horizontal axis is possible.
Public propertyCanVerticallyScrollGets or sets a value that indicates whether scrolling on the vertical axis is possible.
Public propertyExtentHeightGets the vertical size of the extent.
Public propertyExtentWidthGets the horizontal size of the extent.
Public propertyHorizontalOffsetGets the horizontal offset of the scrolled content.
Public propertyScrollOwnerGets or sets a ScrollViewer element that controls scrolling behavior.
Public propertyVerticalOffsetGets the vertical offset of the scrolled content.
Public propertyViewportHeightGets the vertical size of the viewport for this content.
Public propertyViewportWidthGets the horizontal size of the viewport for this content.
Top

  NameDescription
Public methodLineDownScrolls down within content by one logical unit.
Public methodLineLeftScrolls left within content by one logical unit.
Public methodLineRightScrolls right within content by one logical unit.
Public methodLineUpScrolls up within content by one logical unit.
Public methodMakeVisibleForces content to scroll until the coordinate space of a Visual object is visible.
Public methodMouseWheelDownScrolls down within content after a user clicks the wheel button on a mouse.
Public methodMouseWheelLeftScrolls left within content after a user clicks the wheel button on a mouse.
Public methodMouseWheelRightScrolls right within content after a user clicks the wheel button on a mouse.
Public methodMouseWheelUpScrolls up within content after a user clicks the wheel button on a mouse.
Public methodPageDownScrolls down within content by one page.
Public methodPageLeftScrolls left within content by one page.
Public methodPageRightScrolls right within content by one page.
Public methodPageUpScrolls up within content by one page.
Public methodSetHorizontalOffsetSets the amount of horizontal offset.
Public methodSetVerticalOffsetSets the amount of vertical offset.
Top

The IScrollInfo interface exposes access to methods that enable logical scrolling of child content as well as computing which child elements are visible. In addition, it defines properties used to define the scrollable region.

Logical scrolling enables scrolling to the next element in the logical tree. Physical scrolling, in contrast, scrolls content by a defined measurable increment in a specified direction. If you require physical scrolling instead of logical scrolling, wrap the host Panel element in a ScrollViewer and set the value of its CanContentScroll property to false.

This example shows how to scroll content by using the IScrollInfo interface.

The following example demonstrates the features of the IScrollInfo interface. The example creates a StackPanel element in Extensible Application Markup Language (XAML) that is nested in a parent ScrollViewer. The child elements of the StackPanel can be scrolled logically by using the methods defined by the IScrollInfo interface and cast to the instance of StackPanel (sp1) in code.

<Border BorderBrush="Black" Background="White" BorderThickness="2" Width="500" Height="500">
    <ScrollViewer Name="sv1" CanContentScroll="True" VerticalScrollBarVisibility="Visible" HorizontalScrollBarVisibility="Visible">
        <StackPanel Name="sp1">
            <Button>Button 1</Button>
            <Button>Button 2</Button>
            <Button>Button 3</Button>
            <Button>Button 4</Button>
            <Button>Button 5</Button>
            <Rectangle Width="700" Height="500" Fill="Purple"/>
            <TextBlock>Rectangle 1</TextBlock>
            <Rectangle Width="700" Height="500" Fill="Red"/>
            <TextBlock>Rectangle 2</TextBlock>
            <Rectangle Width="700" Height="500" Fill="Green"/>
            <TextBlock>Rectangle 3</TextBlock>
        </StackPanel> 
    </ScrollViewer>
</Border>

Each Button in the XAML file triggers an associated custom method that controls scrolling behavior in StackPanel. The following example shows how to use the LineUp and LineDown methods; it also generically shows how to use all the positioning methods that the IScrollInfo class defines.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft