CommandBarFlyout 类

定义

命名空间:

Microsoft.UI.Xaml.Controls

表示为 AppBarButton、AppBarToggleButton 和 AppBarSeparator 控件提供布局的专用浮出控件。

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.UI.Xaml.Markup.ContentProperty(Name="PrimaryCommands")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class CommandBarFlyout : FlyoutBase

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.UI.Xaml.Markup.ContentProperty(Name="PrimaryCommands")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class CommandBarFlyout : FlyoutBase

Public Class CommandBarFlyout
Inherits FlyoutBase

<CommandBarFlyout .../>
-or-
<CommandBarFlyout>
  commandBarElements
</CommandBarFlyout>

继承

Object IInspectable DependencyObject FlyoutBase CommandBarFlyout

派生

Microsoft.UI.Xaml.Controls.TextCommandBarFlyout

属性

MarshalingBehaviorAttribute ThreadingAttribute ContentPropertyAttribute ContractVersionAttribute

示例

提示

有关详细信息、设计指南和代码示例，请参阅 命令栏浮出控件。

打开 WinUI 3 库应用，查看运行中的 CommandBarFlyout。

WinUI 3 库应用包括大多数 WinUI 3 控件、特性和功能的交互式示例。 通过 Microsoft Store 获取应用，或在 GitHub 上获取源代码

注解

通过将其他控件包装在 AppBarElementContainer 中，可以将其他控件添加到 CommandBarFlyout。 这包括 DropDownButton 或 SplitButton 等控件，或用于更复杂的 UI 的 StackPanel 等容器。

控件样式和模板

可以修改默认 的 Style 和 ControlTemplate ，使控件具有唯一的外观。 有关修改控件的样式和模板的信息，请参阅 XAML 样式。 文件中包括 generic.xaml 定义控件外观的默认样式、模板和资源。 出于设计目的， generic.xaml 随 Windows 应用 SDK NuGet 包一起安装。 默认情况下，此位置是 \Users\<username>\.nuget\packages\microsoft.windowsappsdk\<version>\lib\uap10.0\Microsoft.UI\Themes\generic.xaml。 不同版本的 SDK 中的样式和资源可能具有不同的值。

XAML 还包括可用于在不修改控件模板的情况下修改不同视觉状态中的控件颜色的资源。 修改这些资源是首选设置属性，如 Background 和 Foreground。 有关详细信息，请参阅 XAML 样式一文的轻量级样式部分。

构造函数

CommandBarFlyout()

初始化 CommandBarFlyout 类的新实例。

属性

AllowFocusOnInteraction	获取或设置一个值，该值指示当用户与元素交互时是否自动获得焦点。 (继承自 FlyoutBase)
AllowFocusWhenDisabled	获取或设置一个值，该值指定控件在禁用时是否可以接收焦点。 (继承自 FlyoutBase)
AlwaysExpanded	获取或设置一个值，该值指示 CommandBarFlyout 是否应始终保持其“已展开”状态并阻止用户进入“已折叠”状态。 默认为 false。
AreOpenCloseAnimationsEnabled	获取或设置一个值，该值指示在打开或关闭浮出控件时是否播放动画。 (继承自 FlyoutBase)
Dispatcher	始终在Windows 应用 SDK应用中返回 null 。 请改用 DispatcherQueue 。 (继承自 DependencyObject)
DispatcherQueue	获取 DispatcherQueue 与此 对象关联的 。 DispatcherQueue表示可以访问 DependencyObject UI 线程上的 的功能，即使代码是由非 UI 线程启动的。 (继承自 DependencyObject)
ElementSoundMode	获取或设置一个值，该值指定控件是否播放声音的首选项。 (继承自 FlyoutBase)
InputDevicePrefersPrimaryCommands	获取一个值，该值指示用于打开浮出控件的输入设备是否不容易打开辅助命令。 (继承自 FlyoutBase)
IsConstrainedToRootBounds	获取一个值，该值指示浮出控件是否显示在 XAML 根的边界内。 此属性对于Windows 应用 SDK应用始终为 true。 (继承自 FlyoutBase)
IsOpen	获取一个值，该值指示浮出控件是否打开。 (继承自 FlyoutBase)
LightDismissOverlayMode	获取或设置一个值，该值指定是否将 浅色消除 UI 外部的区域变暗。 (继承自 FlyoutBase)
OverlayInputPassThroughElement	获取或设置一个元素，该元素应接收指针输入事件，即使在浮出控件的覆盖层下也是如此。 (继承自 FlyoutBase)
Placement	获取或设置要用于浮出控件的默认放置位置，相对于其放置目标。 (继承自 FlyoutBase)
PrimaryCommands	获取 CommandBarFlyout 的主命令元素的集合。
SecondaryCommands	获取 CommandBarFlyout 的辅助命令元素的集合。
ShouldConstrainToRootBounds	获取或设置一个值，该值指示是否应在 XAML 根的边界内显示浮出控件。 (继承自 FlyoutBase)
ShowMode	获取或设置一个值，该值指示浮出控件在显示时的行为方式。 (继承自 FlyoutBase)
SystemBackdrop	获取或设置要应用于此浮出控件的系统背景。 背景呈现在浮出控件内容后面。 (继承自 FlyoutBase)
Target	获取要用作浮出控件放置目标的元素。 (继承自 FlyoutBase)
XamlRoot	获取或设置在其中查看此浮出控件的 XamlRoot。 (继承自 FlyoutBase)

方法

ClearValue(DependencyProperty)	清除依赖属性的本地值。 (继承自 DependencyObject)
CreatePresenter()	在派生类中重写时，初始化控件以显示适合派生控件的浮出控件内容。 注意：此方法没有基类实现，必须在派生类中重写。 (继承自 FlyoutBase)
GetAnimationBaseValue(DependencyProperty)	返回为依赖属性建立的任何基值，该基值适用于动画未处于活动状态的情况。 (继承自 DependencyObject)
GetValue(DependencyProperty)	从 DependencyObject 返回依赖属性的当前有效值。 (继承自 DependencyObject)
Hide()	关闭浮出控件。 (继承自 FlyoutBase)
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)	在应用中处理键盘快捷方式 (快捷键) 之前调用。 每当应用程序代码或内部进程调用 ProcessKeyboardAccelerators 时调用。 重写此方法以影响默认加速器处理。 (继承自 FlyoutBase)
ReadLocalValue(DependencyProperty)	如果设置了本地值，则返回依赖属性的本地值。 (继承自 DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	注册一个通知函数，用于侦听此 DependencyObject 实例上特定 DependencyProperty 的更改。 (继承自 DependencyObject)
SetValue(DependencyProperty, Object)	设置 DependencyObject 上依赖属性的本地值。 (继承自 DependencyObject)
ShowAt(DependencyObject, FlyoutShowOptions)	显示使用指定选项相对于指定元素放置的浮出控件。 (继承自 FlyoutBase)
ShowAt(FrameworkElement)	显示相对于指定元素放置的浮出控件。 (继承自 FlyoutBase)
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)	尝试 (快捷键) 调用键盘快捷方式。 (继承自 FlyoutBase)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	取消以前通过调用 RegisterPropertyChangedCallback 注册的更改通知。 (继承自 DependencyObject)

事件

Closed	浮出控件隐藏时发生。 (继承自 FlyoutBase)
Closing	浮出控件开始隐藏时发生。 (继承自 FlyoutBase)
Opened	在显示浮出控件时发生。 (继承自 FlyoutBase)
Opening	在显示浮出控件之前发生。 (继承自 FlyoutBase)

另请参阅

• 命令栏浮出控件