CommandBarFlyout 类

定义

表示为 AppBarButton 和相关命令元素提供布局的专用浮出控件。

适用于 UWP 的等效 WinUI 2 APIMicrosoft.UI.Xaml.Controls.CommandBar 在 Windows 应用 SDK中适用于 WinUI 的 Microsoft.UI.Xaml.Controls.CommandBarFlyout (,请参阅Windows 应用 SDK命名空间) 。

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [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")]
class CommandBarFlyout : FlyoutBase
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[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")]
public class CommandBarFlyout : FlyoutBase
Public Class CommandBarFlyout
Inherits FlyoutBase
<CommandBarFlyout .../>
-or-
<CommandBarFlyout>
  commandBarElements
</CommandBarFlyout>
继承
Object IInspectable DependencyObject FlyoutBase CommandBarFlyout
派生
属性

Windows 要求

设备系列
Windows 10, version 1809 (在 10.0.17763.0 中引入)
API contract
Windows.Foundation.UniversalApiContract (在 v7.0 中引入)

示例

提示

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

如果已安装 WinUI 2 库 应用,请单击此处 打开该应用,并查看 CommandBarFlyout 的运行情况

注解

控件样式和模板

可以修改默认 的 StyleControlTemplate ,使控件具有唯一的外观。 有关修改控件样式和模板的信息,请参阅 设置控件样式。 文件中包括 generic.xaml 定义控件外观的默认样式、模板和资源。 出于设计目的, generic.xaml 通过 SDK 或 NuGet 包安装在本地提供。

  • * 建议) (WinUI 样式: 使用 Microsoft.UI.Xaml.Controls.CommandBarFlyout
  • 非 WinUI 样式: 有关内置样式,请参阅 %ProgramFiles(x86)%\Windows Kits\10\DesignTime\CommonConfiguration\Neutral\UAP\<SDK version>\Generic\generic.xaml

如果自定义安装,位置可能会有所不同。 不同版本的 SDK 中的样式和资源可能具有不同的值。

XAML 还包括可用于在不修改控件模板的情况下修改不同视觉状态中的控件颜色的资源。 修改这些资源是首选设置属性,如 BackgroundForeground。 有关详细信息,请参阅 XAML 样式一文的轻量级样式部分。 从 Windows 10 版本 1607 (SDK 14393) 开始提供轻型样式资源。

构造函数

CommandBarFlyout()

初始化 CommandBarFlyout 类的新实例。

适用于 UWP 的等效 WinUI 2 APIWindows 应用 SDK中适用于 WinUI 的 Microsoft.UI.Xaml.Controls.CommandBarFlyout.-ctor (,请参阅Windows 应用 SDK命名空间) 。

属性

AllowFocusOnInteraction

获取或设置一个值,该值指示当用户与元素交互时是否自动获得焦点。

(继承自 FlyoutBase)
AllowFocusWhenDisabled

获取或设置一个值,该值指定控件在禁用时是否可以接收焦点。

(继承自 FlyoutBase)
AreOpenCloseAnimationsEnabled

获取或设置一个值,该值指示在打开或关闭浮出控件时是否播放动画。

(继承自 FlyoutBase)
Dispatcher

获取与此 对象关联的 CoreDispatcherCoreDispatcher 表示可以访问 UI 线程上的 DependencyObject 的工具,即使代码是由非 UI 线程启动的。

(继承自 DependencyObject)
ElementSoundMode

获取或设置一个值,该值指定控件是否播放声音的首选项。

(继承自 FlyoutBase)
InputDevicePrefersPrimaryCommands

获取一个值,该值指示用于打开浮出控件的输入设备是否不容易打开辅助命令。

(继承自 FlyoutBase)
IsConstrainedToRootBounds

获取一个值,该值指示浮出控件是否显示在 XAML 根的边界内。

(继承自 FlyoutBase)
IsOpen

获取一个值,该值指示浮出控件是否打开。

(继承自 FlyoutBase)
LightDismissOverlayMode

获取或设置一个值,该值指定是否将 浅色消除 UI 外部的区域变暗。

(继承自 FlyoutBase)
OverlayInputPassThroughElement

获取或设置一个元素,该元素应接收指针输入事件,即使在浮出控件的覆盖层下也是如此。

(继承自 FlyoutBase)
Placement

获取或设置要用于浮出控件的默认放置位置,相对于其放置目标。

(继承自 FlyoutBase)
PrimaryCommands

获取 CommandBarFlyout 的主命令元素的集合。

适用于 UWP 的等效 WinUI 2 API:Windows 应用 SDK中适用于 WinUI 的 Microsoft.UI.Xaml.Controls.CommandBarFlyout.PrimaryCommands (,请参阅Windows 应用 SDK命名空间) 。

SecondaryCommands

获取 CommandBarFlyout 的辅助命令元素的集合。

适用于 UWP 的等效 WinUI 2 API:Windows 应用 SDK中适用于 WinUI 的 Microsoft.UI.Xaml.Controls.CommandBarFlyout.SecondaryCommands (,请参阅) Windows 应用 SDK命名空间

ShouldConstrainToRootBounds

获取或设置一个值,该值指示是否应在 XAML 根的边界内显示浮出控件。

(继承自 FlyoutBase)
ShowMode

获取或设置一个值,该值指示浮出控件在显示时的行为方式。

(继承自 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)

适用于