| -api-id | -api-type |
|---|---|
T:Windows.UI.Xaml.Controls.Pivot |
winrt class |
Represents a control that provides quick navigation of views within an app.
<Pivot .../>
-or-
<Pivot ...>
oneOrMorePivotItems
</Pivot>
Tip
For more info, design guidance, and code examples, see Pivot.
Use a Pivot to present groups of content that a user can swipe through. You typically use a Pivot as the top level control on a page.
Pivot is an ItemsControl, so it can contain a collection of items of any type. Any item you add to the Pivot that is not explicitly a PivotItem is implicitly wrapped in a PivotItem. Because a Pivot is often used to navigate between pages of content, it's common to populate the Items collection directly with XAML UI elements. Or, you can set the ItemsSource property to a data source. Items bound in the ItemsSource can be of any type, but if they aren't explicitly PivotItem s, you must define an ItemTemplate and HeaderTemplate to specify how the items are displayed.
You can use the SelectedItem property to get or set the Pivot's active item. Use the SelectedIndex property to get or set the index of the active item.
You can use the LeftHeader and RightHeader properties to add other controls to the Pivot header.
You can modify the default Style and ControlTemplate to give the control a unique appearance. For information about modifying a control's style and template, see Styling controls. The default style, template, and resources that define the look of the control are included in the generic.xaml file. For design purposes, generic.xaml is available locally with the SDK or NuGet package installation.
- WinUI Styles (recommended): For updated styles from WinUI, see
\Users\<username>\.nuget\packages\microsoft.ui.xaml\<version>\lib\uap10.0\Microsoft.UI.Xaml\Themes\generic.xaml. - Non-WinUI styles: For built-in styles, see
%ProgramFiles(x86)%\Windows Kits\10\DesignTime\CommonConfiguration\Neutral\UAP\<SDK version>\Generic\generic.xaml.
Locations might be different if you customized the installation. Styles and resources from different versions of the SDK might have different values.
XAML also includes resources that you can use to modify the colors of a control in different visual states without modifying the control template. Modifying these resources is preferred to setting properties such as Background and Foreground. For more info, see the Light-weight styling section of the XAML styles article. Light-weight styling resources are available starting in Windows 10, version 1607 (SDK 14393).
Pivot is the host service class for a XAML attached property.
In order to support XAML processor access to the attached properties, and also to expose equivalent get and set operations to code, each XAML attached property has a pair of Get and Set accessor methods. Another way to get or set the value in code is to use the dependency property system, calling either GetValue or SetValue and passing the identifier field as the dependency property identifier.
| Attached property | Description |
|---|---|
| SlideInAnimationGroup | Gets or sets the slide-in animation group of a child element in a Pivot container. |
| Windows version | SDK version | Value added |
|---|---|---|
| 1607 | 14393 | HeaderFocusVisualPlacement |
| 1607 | 14393 | IsHeaderItemsCarouselEnabled |
Tip
For more info, design guidance, and code examples, see Pivot.
[!div class="nextstepaction"] Open the WinUI 2 Gallery app and see the Pivot in action
The WinUI 2 Gallery app includes interactive examples of most WinUI 2 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.
This example shows a Pivot with 3 items. It also has a RightHeader with forward and back buttons that use SelectedIndex to let a user navigate through the items.
<Pivot x:Name="rootPivot" Title="PIVOT TITLE">
<Pivot.RightHeader>
<CommandBar ClosedDisplayMode="Compact">
<AppBarButton Icon="Back" Label="Previous" Click="BackButton_Click"/>
<AppBarButton Icon="Forward" Label="Next" Click="NextButton_Click"/>
</CommandBar>
</Pivot.RightHeader>
<PivotItem Header="Pivot Item 1">
<!--Pivot content goes here-->
<TextBlock Text="Content of pivot item 1."/>
</PivotItem>
<PivotItem Header="Pivot Item 2">
<!--Pivot content goes here-->
<TextBlock Text="Content of pivot item 2."/>
</PivotItem>
<PivotItem Header="Pivot Item 3">
<!--Pivot content goes here-->
<TextBlock Text="Content of pivot item 3."/>
</PivotItem>
</Pivot>private void BackButton_Click(object sender, RoutedEventArgs e)
{
if (rootPivot.SelectedIndex > 0)
{
// If not at the first item, go back to the previous one.
rootPivot.SelectedIndex -= 1;
}
else
{
// The first PivotItem is selected, so loop around to the last item.
rootPivot.SelectedIndex = rootPivot.Items.Count-1;
}
}
private void NextButton_Click(object sender, RoutedEventArgs e)
{
if (rootPivot.SelectedIndex < rootPivot.Items.Count-1)
{
// If not at the last item, go to the next one.
rootPivot.SelectedIndex += 1;
}
else
{
// The last PivotItem is selected, so loop around to the first item.
rootPivot.SelectedIndex = 0;
}
}