Windows Dev Center

CommandBar class

Represents a specialized app bar that provides layout for AppBarButton and related command elements.

Inheritance

Object
  DependencyObject
    UIElement
      FrameworkElement
        Control
          ContentControl
            AppBar
              CommandBar

Syntax


public ref class CommandBar : AppBar


<CommandBar .../>
-or-
<CommandBar>
  commandBarElements
</CommandBar>

XAML Values

commandBarElements

One or more object elements for classes that implement ICommandBarElement. These are typically AppBarButton, AppBarToggleButton or AppBarSeparator elements.

Members

The CommandBar class has these types of members:

Constructors

The CommandBar class has these constructors.

ConstructorDescription
CommandBar Initializes a new instance of the CommandBar class.

 

Events

The CommandBar class has these events.

EventDescription
Closed Occurs when the AppBar changes from visible to hidden. (Inherited from AppBar)
Closing Occurs when the AppBar starts to change from visible to hidden. (Inherited from AppBar)
DataContextChanged Occurs when the value of the FrameworkElement.DataContext property changes. (Inherited from FrameworkElement)
DoubleTapped Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement)
DragEnter Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement)
DragLeave Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement)
DragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement)
DragStarting Occurs when a drag operation is initiated. (Inherited from UIElement)
Drop Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement)
DropCompleted Occurs when a drag-and-drop operation is ended. (Inherited from UIElement)
GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement)
Holding Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Inherited from UIElement)
IsEnabledChanged Occurs when the IsEnabled property changes. (Inherited from Control)
KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement)
KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement)
LayoutUpdated Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout. (Inherited from FrameworkElement)
Loaded Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Inherited from FrameworkElement)
Loading Occurs when a FrameworkElement begins to load. (Inherited from FrameworkElement)
LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement)
ManipulationCompleted Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement)
ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement)
ManipulationInertiaStarting Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement)
ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement)
ManipulationStarting Occurs when the manipulation processor is first created. (Inherited from UIElement)
Opened Occurs when the AppBar changes from hidden to visible. (Inherited from AppBar)
Opening Occurs when the AppBar starts to change from hidden to visible. (Inherited from AppBar)
PointerCanceled Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement)
PointerCaptureLost Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement)
PointerEntered Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement)
PointerExited Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement)
PointerMoved Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement)
PointerPressed Occurs when the pointer device initiates a Press action within this element. (Inherited from UIElement)
PointerReleased Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Inherited from UIElement)
PointerWheelChanged Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement)
RightTapped Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement)
SizeChanged Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement)
Tapped Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement)
Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement)

 

Methods

The CommandBar class has these methods. It also inherits methods from the Object class.

MethodDescription
AddHandler Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere. (Inherited from UIElement)
ApplyTemplate Loads the relevant control template so that its parts can be referenced. (Inherited from Control)
Arrange Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement)
ArrangeOverride Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement)
CancelDirectManipulations Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement. (Inherited from UIElement)
CapturePointer Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement)
FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement)
FindSubElementsForTouchTargeting Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement)
Focus Attempts to set the focus on the control. (Inherited from Control)
GetAnimationBaseValue Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetBindingExpression Returns the BindingExpression that represents the binding on the specified property. (Inherited from FrameworkElement)
GetTemplateChild Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control)
GoToElementStateCore When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup. (Inherited from FrameworkElement)
InvalidateArrange Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement)
InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement)
Measure Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement)
MeasureOverride Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement)
OnApplyTemplate Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class. (Inherited from FrameworkElement)
OnClosed Invoked when the AppBar changes from visible to hidden. (Inherited from AppBar)
OnClosing Invoked when the AppBar starts to change from visible to hidden. (Inherited from AppBar)
OnContentChanged Invoked when the value of the Content property changes. (Inherited from ContentControl)
OnContentTemplateChanged Invoked when the value of the ContentTemplate property changes. (Inherited from ContentControl)
OnContentTemplateSelectorChanged Invoked when the value of the ContentTemplateSelector property changes. (Inherited from ContentControl)
OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (Inherited from UIElement)
OnDisconnectVisualChildren Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property. (Inherited from UIElement)
OnDoubleTapped Called before the DoubleTapped event occurs. (Inherited from Control)
OnDragEnter Called before the DragEnter event occurs. (Inherited from Control)
OnDragLeave Called before the DragLeave event occurs. (Inherited from Control)
OnDragOver Called before the DragOver event occurs. (Inherited from Control)
OnDrop Called before the Drop event occurs. (Inherited from Control)
OnGotFocus Called before the GotFocus event occurs. (Inherited from Control)
OnHolding Called before the Holding event occurs. (Inherited from Control)
OnKeyDown Called before the KeyDown event occurs. (Inherited from Control)
OnKeyUp Called before the KeyUp event occurs. (Inherited from Control)
OnLostFocus Called before the LostFocus event occurs. (Inherited from Control)
OnManipulationCompleted Called before the ManipulationCompleted event occurs. (Inherited from Control)
OnManipulationDelta Called before the ManipulationDelta event occurs. (Inherited from Control)
OnManipulationInertiaStarting Called before the ManipulationInertiaStarting event occurs. (Inherited from Control)
OnManipulationStarted Called before the ManipulationStarted event occurs. (Inherited from Control)
OnManipulationStarting Called before the ManipulationStarting event occurs. (Inherited from Control)
OnOpened Invoked when the AppBar changes from hidden to visible, or is first displayed. (Inherited from AppBar)
OnOpening Invoked when the AppBar starts to change from hidden to visible, or starts to be first displayed. (Inherited from AppBar)
OnPointerCanceled Called before the PointerCanceled event occurs. (Inherited from Control)
OnPointerCaptureLost Called before the PointerCaptureLost event occurs. (Inherited from Control)
OnPointerEntered Called before the PointerEntered event occurs. (Inherited from Control)
OnPointerExited Called before the PointerExited event occurs. (Inherited from Control)
OnPointerMoved Called before the PointerMoved event occurs. (Inherited from Control)
OnPointerPressed Called before the PointerPressed event occurs. (Inherited from Control)
OnPointerReleased Called before the PointerReleased event occurs. (Inherited from Control)
OnPointerWheelChanged Called before the PointerWheelChanged event occurs. (Inherited from Control)
OnRightTapped Called before the RightTapped event occurs. (Inherited from Control)
OnTapped Called before the Tapped event occurs. (Inherited from Control)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback Registers an instance-specific property value for a property-changed notification that comes from the core property system. (Inherited from DependencyObject)
ReleasePointerCapture Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement)
ReleasePointerCaptures Releases all pointer captures held by this element. (Inherited from UIElement)
RemoveHandler Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement)
SetBinding Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement)
StartDragAsync Initiates a drag-and-drop operation. (Inherited from UIElement)
TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement)
UnregisterPropertyChangedCallback Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)
UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement)

 

Properties

The CommandBar class has these properties.

PropertyAccess typeDescription

ActualHeight

Read-onlyGets the rendered height of a FrameworkElement. See Remarks. (Inherited from FrameworkElement)

ActualWidth

Read-onlyGets the rendered width of a FrameworkElement. See Remarks. (Inherited from FrameworkElement)

AllowDrop

Read/writeGets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement)

Background

Read/writeGets or sets a brush that provides the background of the control. (Inherited from Control)

BaseUri

Read-onlyGets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time. (Inherited from FrameworkElement)

BorderBrush

Read/writeGets or sets a brush that describes the border fill of a control. (Inherited from Control)

BorderThickness

Read/writeGets or sets the border thickness of a control. (Inherited from Control)

CacheMode

Read/writeGets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)

CanDrag

Read-onlyGets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation. (Inherited from UIElement)

CharacterSpacing

Read/writeGets or sets the uniform spacing between characters, in units of 1/1000 of an em. (Inherited from Control)

Clip

Read/writeGets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement)

ClosedDisplayMode

Read/writeGets or sets a value that indicates whether icon buttons are displayed when the app bar is not completely open. (Inherited from AppBar)

CommandBarOverflowPresenterStyle

Read/writeGets or sets the Style applied to the overflow content of the CommandBar.

CommandBarOverflowPresenterStyleProperty

Read-onlyIdentifies the CommandBarOverflowPresenterStyle dependency property.

CommandBarTemplateSettings

Read-onlyGets an object that provides calculated values that can be referenced as TemplateBinding sources when defining templates for a CommandBar control.

CompositeMode

Read/writeGets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI. (Inherited from UIElement)

Content

Read/writeGets or sets the content of a ContentControl. (Inherited from ContentControl)

ContentTemplate

Read/writeGets or sets the data template that is used to display the content of the ContentControl. (Inherited from ContentControl)

ContentTemplateRoot

Read-onlyGets the root element of the date template specified by the ContentTemplate property. (Inherited from ContentControl)

ContentTemplateSelector

Read/writeGets or sets a selection object that changes the DataTemplate to apply for content, based on processing information about the content item or its container at run time. (Inherited from ContentControl)

ContentTransitions

Read/writeGets or sets the collection of Transition style elements that apply to the content of a ContentControl. (Inherited from ContentControl)

DataContext

Read/writeGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement)

DefaultStyleKey

Read/writeGets or sets the key that references the default style for the control. Authors of custom controls use this property to change the default for the style that their control uses. (Inherited from Control)

DesiredSize

Read-onlyGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)

FlowDirection

Read/writeGets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left. (Inherited from FrameworkElement)

FocusState

Read-onlyGets a value that specifies whether this control has focus, and the mode by which focus was obtained. (Inherited from Control)

FontFamily

Read/writeGets or sets the font used to display text in the control. (Inherited from Control)

FontSize

Read/writeGets or sets the size of the text in this control. (Inherited from Control)

FontStretch

Read/writeGets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control)

FontStyle

Read/writeGets or sets the style in which the text is rendered. (Inherited from Control)

FontWeight

Read/writeGets or sets the thickness of the specified font. (Inherited from Control)

Foreground

Read/writeGets or sets a brush that describes the foreground color. (Inherited from Control)

Height

Read/writeGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement)

HorizontalAlignment

Read/writeGets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement)

HorizontalContentAlignment

Read/writeGets or sets the horizontal alignment of the control's content. (Inherited from Control)

IsDoubleTapEnabled

Read/writeGets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)

IsEnabled

Read/writeGets or sets a value indicating whether the user can interact with the control. (Inherited from Control)

IsHitTestVisible

Read/writeGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)

IsHoldingEnabled

Read/writeGets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)

IsOpen

Read/writeGets or sets a value that indicates whether the AppBar is visible. (Inherited from AppBar)

IsRightTapEnabled

Read/writeGets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)

IsSticky

Read/writeGets or sets a value that indicates whether the AppBar does not close on light dismiss. (Inherited from AppBar)

IsTabStop

Read/writeGets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control)

IsTapEnabled

Read/writeGets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)

IsTextScaleFactorEnabled

Read/writeGets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled. (Inherited from Control)

Language

Read/writeGets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI. (Inherited from FrameworkElement)

ManipulationMode

Read/writeGets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code. (Inherited from UIElement)

Margin

Read/writeGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)

MaxHeight

Read/writeGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MaxWidth

Read/writeGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinHeight

Read/writeGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinWidth

Read/writeGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

Name

Read/writeGets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement)

Opacity

Read/writeGets or sets the degree of the object's opacity. (Inherited from UIElement)

Padding

Read/writeGets or sets the padding inside a control. (Inherited from Control)

Parent

Read-onlyGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)

PointerCaptures

Read-onlyGets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)

PrimaryCommands

Read-onlyGets the collection of primary command elements for the CommandBar.

PrimaryCommandsProperty

Read-onlyIdentifies the PrimaryCommands dependency property.

Projection

Read/writeGets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)

RenderSize

Read-onlyGets the final render size of a UIElement. (Inherited from UIElement)

RenderTransform

Read/writeGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement)

RenderTransformOrigin

Read/writeGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement)

RequestedTheme

Read/writeGets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme. (Inherited from FrameworkElement)

Resources

Read/writeGets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement)

SecondaryCommands

Read-onlyGets the collection of secondary command elements for the CommandBar.

SecondaryCommandsProperty

Read-onlyIdentifies the SecondaryCommands dependency property.

Style

Read/writeGets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement)

TabIndex

Read/writeGets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. (Inherited from Control)

TabNavigation

Read/writeGets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control)

Tag

Read/writeGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement)

Template

Read/writeGets or sets a control template. The control template defines the visual appearance of a control in UI, and is defined in XAML markup. (Inherited from Control)

Transform3D

Read-onlyGets or sets the 3-D transform effect to apply when rendering this element. (Inherited from UIElement)

Transitions

Read/writeGets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)

Triggers

Read-onlyGets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement)

UseLayoutRounding

Read/writeGets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement)

UseSystemFocusVisuals

Read/writeGets or sets a value that indicates whether the control uses focus visuals that are drawn by the system or those defined in the control template. (Inherited from Control)

VerticalAlignment

Read/writeGets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement)

VerticalContentAlignment

Read/writeGets or sets the vertical alignment of the control's content. (Inherited from Control)

Visibility

Read/writeGets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout. (Inherited from UIElement)

Width

Read/writeGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)

 

Remarks

Use a CommandBar to provide users with quick access to your app’s most common tasks. It's a general-purpose, flexible, light-weight control that can display both complex content, such as images, progress bars, or text blocks, as well as simple commands such as AppBarButton, AppBarToggleButton, and AppBarSeparator controls.

Anatomy

By default, the CommandBar shows a row of icon buttons and a "More" button, which is represented by an ellipsis [•••]. Here's the CommandBar created by the example code shown later. It's shown in its default closed state.

A compact command bar

Here's the same CommandBar shown in its open state. The labels show the main parts of the control.

Parts of a command bar

The CommandBar is divided into 4 main areas:

  • The content area is shown on the left.
  • The "More" button is shown on the right. Pressing the "More" button has 2 effects: it reveals the labels on the primary command buttons, and it opens the overflow menu if any secondary commands are present.
  • The primary commands are shown to the left of the "More" button.
  • The overflow menu is shown only when the CommandBar is open and contains secondary commands.

The layout is reversed when the FlowDirection is RightToLeft.

Content and commands

CommandBar has 3 properties you can use to add content and commands: Content, PrimaryCommands, and SecondaryCommands.

You can add any XAML elements to the content area by setting the Content property.

Both the PrimaryCommands and SecondaryCommands can be populated only with AppBarButton, AppBarToggleButton, and AppBarSeparator command elements. By default, items you add to the CommandBar are added to the PrimaryCommands collection. These commands are shown to the left of the "More" button. You can add commands to the SecondaryCommands collection, and these items are shown in the overflow menu. You can programmatically move commands between the PrimaryCommands and SecondaryCommands as needed.

The app bar button controls are characterized by an icon and associated label. They have two sizes; normal and compact. By default, the text label is shown. When the IsCompact property is set to true, the text label is hidden. When used in a CommandBar control, the CommandBar sets the IsCompact property automatically as the control is opened and closed.

If the width of a button needs to be greater than the default when shown in the PrimaryCommands, use the MinWidth property to achieve the desired size. Then, if you later move it to the SecondaryCommands, it will still stretch to fill the width of the overflow menu.

If a text label for an app bar button is too long to fit on one line it will wrap to another line, increasing the overall height of the bar when it’s opened. You can include a soft-hyphen character (0x00AD) in the text for a label to hint at the character boundary where a word break should occur. In XAML, you express this using an escape sequence, like this:


<AppBarButton Icon="Back" Label="Areally&#x00AD;longlabel"/>

When the label wraps at the hinted location, it looks like this.

A minimal command bar

Open and closed states

The CommandBar can be open or closed. A user can switch between these states by pressing the "More" button. You can switch between them programmatically by setting the IsOpen property. You can use the Opening, Opened, Closing, and Closed events to respond to the CommandBar being opened or closed.

When open, the primary command buttons are shown with text labels and the overflow menu is open if secondary commands are present. The default overflow menu is styled to be distinct from the bar. You can adjust the styling by setting the CommandBarOverflowPresenterStyle property to a Style that targets the CommandBarOverflowPresenter.

You can control how the CommandBar is shown in its closed state by setting the ClosedDisplayMode property. By default, it’s shown in the Compact mode, with content, icons without labels, and the "More" button. You can set the mode to Minimal to show only a thin bar that acts as the "More" button. In Minimal mode, the user can press anywhere on the bar to open it. Here's how the CommandBar looks in Minimal mode.

A minimal command bar

Changing the ClosedDisplayMode to provide more or less of a hint to the user affects the layout of surrounding elements. When the CommandBar transitions between closed and open, it does not affect the layout of other elements.

IsSticky

After opening the CommandBar, if the user interacts with the app anywhere outside of the control then by default the overflow menu is dismissed and the labels are hidden. Closing it in this way is called light dismiss. You can control how the bar is dismissed by setting the IsSticky property. When the bar is sticky (IsSticky="true"), it's not closed by a light dismiss gesture. The app bar remains visible until the user presses the "More" button or, if present, selects an item from the overflow menu.

Placement

You can place a CommandBar inline with your app content, anywhere in your XAML. If the CommandBar must remain visible to a user when the touch keyboard, or Soft Input Panel (SIP), appears then you can assign it to the BottomAppBar property of a Page and it will move to remain visible when the SIP is present. Otherwise, you should place it inline and positioned relative to your app content. Where you place the CommandBar will influence things like whether you make it sticky, or use the minimal mode when it's closed. For more info and guidance, see Guidelines for command bars.

Examples

This example creates the command bar shown previously.


<CommandBar>
    <AppBarToggleButton Icon="Shuffle" Label="Shuffle" Click="AppBarButton_Click" />
    <AppBarToggleButton Icon="RepeatAll" Label="Repeat" Click="AppBarButton_Click"/>
    <AppBarSeparator/>
    <AppBarButton Icon="Back" Label="Back" Click="AppBarButton_Click"/>
    <AppBarButton Icon="Stop" Label="Stop" Click="AppBarButton_Click"/>
    <AppBarButton Icon="Play" Label="Play" Click="AppBarButton_Click"/>
    <AppBarButton Icon="Forward" Label="Forward" Click="AppBarButton_Click"/>

    <CommandBar.SecondaryCommands>
        <AppBarButton Icon="Like" Label="Like" Click="AppBarButton_Click"/>
        <AppBarButton Icon="Dislike" Label="Dislike" Click="AppBarButton_Click"/>
    </CommandBar.SecondaryCommands>

    <CommandBar.Content>
        <TextBlock Text="Now playing..." Margin="12,14"/>
    </CommandBar.Content>
</CommandBar>

Requirements (Windows 10 device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8.1 [Windows Store apps only]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.winmd

Attributes

[ContentProperty("Name=PrimaryCommands")]
[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06030000)]
[WebHostHidden()]

See also

Object
AppBar
CommandBar styles and templates
Related controls
AppBarButton
AppBarSeparator
AppBarToggleButton
Controls list
Controls by function
Designers
Guidelines for app bars

 

 

Show:
© 2015 Microsoft