ScrollViewer.CanContentScroll Property (System.Windows.Controls)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

ScrollViewer.CanContentScroll Property

Updated: July 2010

Gets or sets a value that indicates whether elements that support the IScrollInfo interface are allowed to scroll.

Namespace: System.Windows.Controls
Assembly: PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

Syntax

Visual Basic

Public Property CanContentScroll As Boolean
	Get
	Set

public bool CanContentScroll { get; set; }

Visual C++

public:
property bool CanContentScroll {
	bool get ();
	void set (bool value);
}

member CanContentScroll : bool with get, set

XAML Attribute Usage

<object CanContentScroll="bool" .../>

Property Value

Type: System.Boolean
true if the ScrollViewer scrolls in terms of logical units; false if the ScrollViewer scrolls in terms of physical units. The default is false.

Dependency Property Information

Identifier field	CanContentScrollProperty
Metadata properties set to true	None

Remarks

Content in a ScrollViewer can be scrolled in terms of physical units or logical units. Physical units are device independent pixels. Logical units are used for scrolling items within an ItemsControl. The default behavior of the ScrollViewer is to use physical units to scroll its content. However, in cases where the CanContentScroll is set to true, the content could use logical units to scroll. For example, ListBox, ListView, and other controls that inherit from ItemsControl use logical units to scroll. If CanContentScroll is true, the values of the ExtentHeight, ScrollableHeight, ViewportHeight, and VerticalOffset properties are number of items, instead of physical units.

If you require physical scrolling instead of logical scrolling, wrap the host Panel element in a ScrollViewer and set its CanContentScroll property to false. Physical scrolling is the default scroll behavior for most Panel elements.

Examples

The following example demonstrates how to set the CanContentScroll property by using code.

Visual Basic


Private Sub scrollTrue(ByVal sender As Object, ByVal args As RoutedEventArgs)
    sv1.CanContentScroll = True
    sv1.Height = 600
    myStackPanel.Visibility = Visibility.Visible
    btn1.Visibility = Visibility.Collapsed
End Sub


private void scrollTrue(object sender, RoutedEventArgs e)
{
    sv1.CanContentScroll = true;
    sv1.Height = 600;
    myStackPanel.Visibility = Visibility.Visible;
    btn1.Visibility = Visibility.Collapsed;
}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

ScrollViewer Class

System.Windows.Controls Namespace

Change History

Date	History	Reason
July 2010	Clarified return value.	Customer feedback.

Date

History

Reason

July 2010

Clarified return value.

Customer feedback.