ScrollViewer.IsHorizontalRailEnabled Property

Definition

Gets or sets a value that indicates whether the scroll rail is enabled for the horizontal axis.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.ScrollViewer.IsHorizontalRailEnabled.

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

void IsHorizontalRailEnabled(bool value);
public bool IsHorizontalRailEnabled { get; set; }
var boolean = scrollViewer.isHorizontalRailEnabled;
scrollViewer.isHorizontalRailEnabled = boolean;
Public Property IsHorizontalRailEnabled As Boolean
<ScrollViewer IsHorizontalRailEnabled="bool" />
-or-
<object ScrollViewer.IsHorizontalRailEnabled="bool"/>

Property Value

Boolean

True to enable the horizontal scroll rail; otherwise, false. The default is true.

Remarks

When content is scrolled without manipulating the scrollbar directly, for example, by touch, we call it panning. Because content can be both wider and taller than the display area, two-dimensional panning (horizontal and vertical) is often necessary. Rails improve the user experience in these cases by locking the panning to the axis of motion, either vertical or horizontal, as if the content were on a rail.

The following diagram demonstrates the concept of rails.

diagram of a screen with rails that constrain panning

For more info, see Guidelines for panning.

Applies to

See also