通过

命令栏

命令栏为用户提供了轻松访问应用内最常见任务的途径。 命令栏可以提供访问应用程序级别或页面特定的命令，并可以用于任何导航模式。

带有图标的命令栏示例

这是正确的控制吗？

CommandBar 控件是一种通用、灵活的轻型控件，可以显示复杂内容（如图像或文本块），以及简单的命令，如 AppBarButton、AppBarToggleButton 和 AppBarSeparator 控件。

解剖学

默认情况下，命令栏显示一行图标按钮和一个可选的“查看更多”按钮，该按钮由省略号 [...] 表示。下面是由稍后展示的示例代码创建的命令栏。 它以关闭的紧凑状态显示。

显示关闭的命令栏的屏幕截图。

命令栏也可以以如下所示的关闭最小状态显示。 有关详细信息，请参阅 “打开和关闭状态 ”部分。

显示处于关闭最小状态的命令栏的屏幕截图。

下面是处于打开状态的相同命令栏。 标签标识控件的主要部分。

显示处于打开状态的命令栏的屏幕截图。

命令栏分为 4 个主要区域：

  • 内容区域与栏的左侧对齐。 如果Content属性已填充，则会显示相关内容。
  • 主要命令区域与栏的右侧对齐。 如果PrimaryCommands属性被填充，则会显示内容。
  • “查看更多”[...] 按钮显示在该栏的右侧。 按“查看更多”[...] 按钮会显示主要命令标签并在存在辅助命令的情况下打开溢出菜单。 当不存在任何主要命令标签或辅助标签时，该按钮将不可见。 若要更改默认行为，请使用 OverflowButtonVisibility 属性。
  • 仅当命令栏打开并填充 SecondaryCommands 属性时，才会显示溢出菜单。 当空间有限时，主要命令会移到 SecondaryCommands 区域中。 若要更改默认行为，请使用 IsDynamicOverflowEnabled 属性。

当 FlowDirection 为 RightToLeft 时，布局将相反。

安置

命令栏可以放置在应用窗口顶部、底部和内联放置，方法是将其嵌入到布局控件（例如 ）中。

应用栏放置示例 1

  • 对于小型手持设备，我们建议将命令栏定位到屏幕底部，以便轻松到达。
  • 对于具有较大屏幕的设备，将命令栏靠近窗口顶部放置会使它们更为醒目，并且更易于发现。

使用 DiagonalSizeInInches API 来确定物理屏幕尺寸。

命令栏可以放置在单视图屏幕（左图）和多视图屏幕上的以下屏幕区域（右图）。 内联命令栏可以放置在操作空间中的任意位置。

应用栏放置示例 2

触摸设备：如果当触摸键盘或软输入面板（SIP）出现时，命令栏必须对用户保持可见，则可以将命令栏分配给页面的 BottomAppBar 属性，当 SIP 存在时，该命令栏将保持可见。 否则，应将命令栏内联放置并相对于应用内容定位。

创建命令栏

  • 重要 API：CommandBar 类、 AppBarButton 类、 AppBarToggleButton 类、 AppBarSeparator 类

打开 WinUI 3 Gallery 应用程序，并查看命令栏的运行情况

WinUI 3 画廊图标 WinUI 3 示例库应用包括 WinUI 控件和功能的交互示例。 从 Microsoft Store 或浏览 GitHub 上的源代码获取应用。

此示例创建前面显示的命令栏。

<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 Label="Like" Click="AppBarButton_Click"/>
        <AppBarButton Label="Dislike" Click="AppBarButton_Click"/>
    </CommandBar.SecondaryCommands>

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

命令和内容

CommandBar 控件有 3 个可用于添加命令和内容的属性： PrimaryCommands、 SecondaryCommands 和 Content。

指令

默认情况下，命令栏项目会被添加到 PrimaryCommands 集合中。 应按命令重要性的顺序添加命令，以便最重要的命令始终可见。 当命令栏的宽度发生变化时，例如当用户调整应用窗口的大小，主要命令会在响应式布局的断点处在命令栏和溢出菜单之间动态移动。 若要更改此默认行为，请使用 IsDynamicOverflowEnabled 属性。

在最小的屏幕（宽度为 320 epx）上，命令栏中最多可放入 4 个主要命令。

你也可以将命令添加到 SecondaryCommands 集合中，该集合将显示在溢出菜单中。

包含“更多”区域和图标的命令栏示例

可以根据需要以编程方式在 PrimaryCommands 和 SecondaryCommands 之间移动命令。

  • 如果某个命令会一直显示在各个页面上，则最好将该命令放置在一个一致的位置上。
  • 我们建议将“接受”、“是”和“确定”命令放置在“拒绝”、“否”和“取消”的左侧。 一致性可以增加用户浏览系统的信心，并帮助他们在应用之间传递应用导航知识。

应用栏按钮

PrimaryCommands 和 SecondaryCommands 只能填充实现 ICommandBarElement 接口的类型，其中包括 AppBarButton、 AppBarToggleButton 和 AppBarSeparator 命令元素。

如果要在 PrimaryCommands 或 SecondaryCommands 中包含不同类型的元素，可以使用 AppBarElementContainer 类。 这将用作元素的包装器，并使元素能够显示在 CommandBar 中。

应用栏按钮控件以一个图标和文本标签为特征。 这些控件经过优化以便在命令栏中使用，它们的外观根据控件是用在命令栏中还是溢出菜单中进行更改。

Icons

在主命令区域中显示时，图标大小为 20x20px；在溢出菜单中，图标按 16x16px 显示。 如果使用 SymbolIcon、 FontIcon 或 PathIcon，则当命令进入辅助命令区域时，图标将自动缩放为正确的大小，且不会丢失保真度。

有关设置图标的详细信息和示例，请参阅 AppBarButton 类的文档。

标签

AppBarButton IsCompact 属性确定是否显示标签。 在 CommandBar 控件中，命令栏随着命令栏的打开和关闭而自动覆盖按钮的 IsCompact 属性。

若要定位应用栏按钮标签，请使用 CommandBar 的 DefaultLabelPosition 属性。

<CommandBar DefaultLabelPosition="Right">
    <AppBarToggleButton Icon="Edit" Label="Edit"/>
    <AppBarToggleButton Icon="Share" Label="Share"/>
</CommandBar>

右侧带有标签的命令栏

在较大的窗口上，请考虑将标签移动到应用栏按钮图标的右侧，以改善可读性。 底部的标签要求用户打开命令栏以显示标签，而右侧的标签即使在命令栏关闭时也可见。

在溢出菜单中，标签默认放在图标右侧，并且忽略 LabelPosition。 可以通过将 CommandBarOverflowPresenterStyle 属性设置为以 CommandBarOverflowPresenter 为目标的 Style 来调整样式。

按钮标签应短，最好是一个单词。 图标下方较长的标签会换行显示为多行，从而导致命令栏打开时的总体高度增加。 可以在文本中包含软连字符（0x00AD），以便标签提示字符边界，其中应发生断字。 在 XAML 中，使用转义序列来表达此内容，如下所示：

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

当标签包装在提示的位置时，它如下所示。

带有换行标签的应用栏按钮

分隔按钮

可以使用内置的 和 类在 CommandBar 中显示 SplitButton。 提供 SplitButton 的视觉对象，使其看起来像是一个 AppBarButton，而 是一个包装器类，它提供 SplitButton 需要的功能，使其表现得像一个 AppBarButton。

在 中包装 SplitButton 并将其放在 CommandBar 中时，将会自动应用 资源。

此示例代码创建并显示 CommandBar 中的 SplitButton：

<CommandBar>
    <AppBarButton Icon="Copy" ToolTipService.ToolTip="Copy" Label="Copy"/>
    <AppBarElementContainer>
        <muxc:SplitButton ToolTipService.ToolTip="Insert" Content="Insert">
            <muxc:SplitButton.Flyout>
                <MenuFlyout Placement="RightEdgeAlignedTop">
                    <MenuFlyoutItem Text="Insert above"/>
                    <MenuFlyoutItem Text="Insert between"/>
                    <MenuFlyoutItem  Text="Insert below"/>
                </MenuFlyout>
            </muxc:SplitButton.Flyout>
        </muxc:SplitButton>
    </AppBarElementContainer>
    <AppBarButton Label="Select all"/>
    <AppBarButton Label="Delete" Icon="Delete"/>
</CommandBar>

考虑对命令进行逻辑分组，例如在“答复”菜单中放置“答复”、“全部答复”和“转发”。 虽然应用栏按钮通常激活单个命令，但应用栏按钮可用于显示具有自定义内容的 MenuFlyout 或 浮出控件 。

用于排序选项的 MenuFlyout 示例：命令栏上的浮出控件示例

其他内容

可以通过设置 Content 属性将任何 XAML 元素添加到内容区域。 如果要添加多个元素，则需要将它们放置在面板容器中，并使面板成为 Content 属性的单个子级。

启用动态溢出时不会裁剪内容，这是因为主要命令可移动到溢出菜单中。 否则，主要命令具有优先权，可能会导致内容裁剪。

当 ClosedDisplayMode 为 Compact 时，如果内容大于命令栏的压缩大小，则可以将其剪裁。 你应该处理 “打开 ”和 “关闭 ”事件，以显示或隐藏内容区域中的 UI 部分，以便它们不会被剪裁。 有关详细信息，请参阅 “打开和关闭状态 ”部分。

打开和关闭状态

命令栏可以打开或关闭。 打开它时，它显示带有文本标签的主命令按钮，并打开溢出菜单（如果有辅助命令）。 命令栏向上（主命令上方）或向下（主命令下方）展开溢出菜单。 默认方向为向上，但如果没有足够空间向上展开溢出菜单，则命令栏向下展开。

用户可通过按“查看更多”[...] 按钮在这些状态之间切换。 可以通过设置 IsOpen 属性以编程方式在它们之间切换。

可以使用 “打开中”、“已打开”、“关闭” 和 “已关闭” 事件来响应命令栏的打开或关闭。

  • 在切换动画开始之前发生“开始”和“关闭”事件。
  • 转换完成后，会触发“打开”和“关闭”事件。

在此示例中，“开始”和“关闭”事件用于更改命令栏的不透明度。 当命令栏关闭时，它是半透明的，因此可以显示应用的背景。 打开命令栏时，命令栏将变得不透明，以便用户可以专注于命令。

<CommandBar Opening="CommandBar_Opening"
            Closing="CommandBar_Closing">
    <AppBarButton Icon="Accept" Label="Accept"/>
    <AppBarButton Icon="Edit" Label="Edit"/>
    <AppBarButton Icon="Save" Label="Save"/>
    <AppBarButton Icon="Cancel" Label="Cancel"/>
</CommandBar>

private void CommandBar_Opening(object sender, object e)
{
    CommandBar cb = sender as CommandBar;
    if (cb != null) cb.Background.Opacity = 1.0;
}

private void CommandBar_Closing(object sender, object e)
{
    CommandBar cb = sender as CommandBar;
    if (cb != null) cb.Background.Opacity = 0.5;
}

IsSticky

如果用户在命令栏处于打开状态时与应用的其他部分交互，命令栏将自动关闭。 这称为轻触关闭。 可以通过设置 IsSticky 属性来控制轻型消除行为。 如果 ，在用户按“查看更多”[...] 按钮或从溢出菜单中选择项目之前，该栏保持打开状态。

建议避免使用粘滞命令栏，因为它们不符合用户对轻型消除和键盘焦点行为的预期。

显示模式

可以通过设置 ClosedDisplayMode 属性来控制命令栏在其关闭状态中的显示方式。 有 3 种关闭的显示模式可供选择：

  • 压缩：默认模式。 显示内容、不带标签的主要命令图标和“查看更多”[...] 按钮。
  • 最小：仅显示一条细栏，作为“查看更多”[...] 按钮。 用户可以按栏上的任意位置将其打开。
  • 隐藏：命令栏在关闭时不显示。 这可用于显示带有内联命令栏的上下文命令。 在这种情况下，必须通过设置 IsOpen 属性或将 ClosedDisplayMode 更改为 Minimal 或 Compact，以编程方式打开命令栏。

此处，命令栏用于保存 RichEditBox 的简单格式设置命令。 当编辑框没有焦点时，格式设置命令可能会分散注意力，因此它们会被隐藏。 使用编辑框时，命令栏的 ClosedDisplayMode 将更改为 Compact，以便格式设置命令可见。

<StackPanel Width="300"
            GotFocus="EditStackPanel_GotFocus"
            LostFocus="EditStackPanel_LostFocus">
    <CommandBar x:Name="FormattingCommandBar" ClosedDisplayMode="Hidden">
        <AppBarButton Icon="Bold" Label="Bold" ToolTipService.ToolTip="Bold"/>
        <AppBarButton Icon="Italic" Label="Italic" ToolTipService.ToolTip="Italic"/>
        <AppBarButton Icon="Underline" Label="Underline" ToolTipService.ToolTip="Underline"/>
    </CommandBar>
    <RichEditBox Height="200"/>
</StackPanel>

private void EditStackPanel_GotFocus(object sender, RoutedEventArgs e)
{
    FormattingCommandBar.ClosedDisplayMode = AppBarClosedDisplayMode.Compact;
}

private void EditStackPanel_LostFocus(object sender, RoutedEventArgs e)
{
    FormattingCommandBar.ClosedDisplayMode = AppBarClosedDisplayMode.Hidden;
}

注释

编辑命令的实现超出了此示例的范围。 有关详细信息，请参阅 RichEditBox 文章。

尽管“最小”和“隐藏”模式在某些情况下很有用，但请记住，隐藏所有操作可能会使用户感到困惑。

更改 ClosedDisplayMode 以向用户提供或多或少的提示会影响周围元素的布局。 相比之下，当 CommandBar 在关闭和打开之间切换时，它不会影响其他元素的布局。

  • Last updated on