Pivot.IsHeaderItemsCarouselEnabled Property

Definition

Gets or sets a value that indicates whether the selected header moves to the first position.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Pivot.IsHeaderItemsCarouselEnabled.

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

void IsHeaderItemsCarouselEnabled(bool value);
public bool IsHeaderItemsCarouselEnabled { get; set; }
var boolean = pivot.isHeaderItemsCarouselEnabled;
pivot.isHeaderItemsCarouselEnabled = boolean;
Public Property IsHeaderItemsCarouselEnabled As Boolean
<Pivot IsHeaderItemsCarouselEnabled="bool" />

Property Value

Boolean

bool

true if the selected header moves to the first position; false if headers always keep the same position. The default is true.

Windows requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Remarks

This property has an effect only when the Pivot doesn't have enough space to show all the headers. If space is available, all headers are shown regardless of this property setting.

By default, the selected Pivot header always moves to the first position (far left), and the headers carousel. The user can pan infinitely and the content just wraps around from front to back.

When this property is false, the Pivot headers always keep the same position. Scrolling is enabled to show headers that don't fit in the viewport.

Version compatibility

The IsHeaderItemsCarouselEnabled property is not available prior to Windows 10, version 1607. If your app’s 'minimum platform version' setting in Microsoft Visual Studio is less than the 'introduced version' shown in the Requirements block later in this page, you must design and test your app to account for this. For more info, see Version adaptive code.

To avoid exceptions when your app runs on previous versions of Windows 10, do not set this property in XAML or use it without performing a runtime check. This example shows how to use the ApiInformation class to check for the presence of this property before you set it.

<Pivot x:Name="pivot1" Loaded="Pivot_Loaded">
    ...
</Pivot>
private void Pivot_Loaded(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.Pivot", "IsHeaderItemsCarouselEnabled"))
    {
        pivot1.IsHeaderItemsCarouselEnabled = false;
    }
}

Applies to