AppBarToggleButton.LabelPosition Property

Definition

Namespace:

Windows.UI.Xaml.Controls

Gets or sets a value that indicates the placement and visibility of the button's label.

public:
 property CommandBarLabelPosition LabelPosition { CommandBarLabelPosition get(); void set(CommandBarLabelPosition value); };

CommandBarLabelPosition LabelPosition();

void LabelPosition(CommandBarLabelPosition value);

public CommandBarLabelPosition LabelPosition { get; set; }

var commandBarLabelPosition = appBarToggleButton.labelPosition;
appBarToggleButton.labelPosition = commandBarLabelPosition;

Public Property LabelPosition As CommandBarLabelPosition

<AppBarToggleButton LabelPosition="commandBarLabelPositionMemberName" />

Property Value

CommandBarLabelPosition

An enumeration value that specifies the placement and visibility of the button's label. The default is Default.

Windows requirements

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

Remarks

By default, the app bar button's label is displayed in the position specified by the CommandBar.DefaultLabelPosition property. You can set the LabelPosition property to override this value and make the label always collapsed for a specific app bar button.

Version compatibility

The LabelPosition 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.

<CommandBar x:Name="commandBar1" Loaded="CommandBar_Loaded">
    <AppBarToggleButton x:Name="appBarButtonShuffle" Icon="Shuffle" Label="Shuffle"/>
</CommandBar>

private void CommandBar_Loaded(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.AppBarToggleButton", "LabelPosition"))
    {
        appBarButtonShuffle.LabelPosition = CommandBarLabelPosition.Collapsed;
    }
}