CommandBarFlyout Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a specialized flyout that provides layout for AppBarButton and related command elements.
Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.CommandBarFlyout (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
/// [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 : FlyoutBasePublic Class CommandBarFlyout
Inherits FlyoutBase<CommandBarFlyout .../>
-or-
<CommandBarFlyout>
commandBarElements
</CommandBarFlyout>
- Inheritance
- Derived
- Attributes
Windows requirements
| Device family |
Windows 10, version 1809 (introduced in 10.0.17763.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v7.0)
|
Examples
Tip
For more info, design guidance, and code examples, see Command bar flyout.
If you have the WinUI 2 Gallery app installed, click here to open the app and see the CommandBarFlyout in action.
Remarks
Control style and template
You can modify the default Style and ControlTemplate to give the control a unique appearance. For information about modifying a control's style and template, see Styling controls. The default style, template, and resources that define the look of the control are included in the generic.xaml file. For design purposes, generic.xaml is available locally with the SDK or NuGet package installation.
- *WinUI Styles (recommended): Use Microsoft.UI.Xaml.Controls.CommandBarFlyout.
- Non-WinUI styles: For built-in styles, see
%ProgramFiles(x86)%\Windows Kits\10\DesignTime\CommonConfiguration\Neutral\UAP\<SDK version>\Generic\generic.xaml.
Locations might be different if you customized the installation. Styles and resources from different versions of the SDK might have different values.
XAML also includes resources that you can use to modify the colors of a control in different visual states without modifying the control template. Modifying these resources is preferred to setting properties such as Background and Foreground. For more info, see the Light-weight styling section of the XAML styles article. Light-weight styling resources are available starting in Windows 10, version 1607 (SDK 14393).
Constructors
| CommandBarFlyout() |
Initializes a new instance of the CommandBarFlyout class. Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.CommandBarFlyout.-ctor (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). |
Properties
| AllowFocusOnInteraction |
Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it. (Inherited from FlyoutBase) |
| AllowFocusWhenDisabled |
Gets or sets a value that specifies whether the control can receive focus when it's disabled. (Inherited from FlyoutBase) |
| AreOpenCloseAnimationsEnabled |
Gets or sets a value that indicates whether animations are played when the flyout is opened or closed. (Inherited from FlyoutBase) |
| Dispatcher |
Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject) |
| ElementSoundMode |
Gets or sets a value that specifies the control's preference for whether it plays sounds. (Inherited from FlyoutBase) |
| InputDevicePrefersPrimaryCommands |
Gets a value that indicates whether the input device used to open the flyout does not easily open the secondary commands. (Inherited from FlyoutBase) |
| IsConstrainedToRootBounds |
Gets a value that indicates whether the flyout is shown within the bounds of the XAML root. (Inherited from FlyoutBase) |
| IsOpen |
Gets a value that indicates whether the flyout is open. (Inherited from FlyoutBase) |
| LightDismissOverlayMode |
Gets or sets a value that specifies whether the area outside of a light-dismiss UI is darkened. (Inherited from FlyoutBase) |
| OverlayInputPassThroughElement |
Gets or sets an element that should receive pointer input events even when underneath the flyout's overlay. (Inherited from FlyoutBase) |
| Placement |
Gets or sets the default placement to be used for the flyout, in relation to its placement target. (Inherited from FlyoutBase) |
| PrimaryCommands |
Gets the collection of primary command elements for the CommandBarFlyout. Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.CommandBarFlyout.PrimaryCommands (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). |
| SecondaryCommands |
Gets the collection of secondary command elements for the CommandBarFlyout. Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.CommandBarFlyout.SecondaryCommands (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). |
| ShouldConstrainToRootBounds |
Gets or sets a value that indicates whether the flyout should be shown within the bounds of the XAML root. (Inherited from FlyoutBase) |
| ShowMode |
Gets or sets a value that indicates how a flyout behaves when shown. (Inherited from FlyoutBase) |
| Target |
Gets the element to use as the flyout's placement target. (Inherited from FlyoutBase) |
| XamlRoot |
Gets or sets the XamlRoot in which this flyout is being viewed. (Inherited from FlyoutBase) |
Methods
| ClearValue(DependencyProperty) |
Clears the local value of a dependency property. (Inherited from DependencyObject) |
| CreatePresenter() |
When overridden in a derived class, initializes a control to show the flyout content as appropriate for the derived control. Note: This method has no base class implementation and must be overridden in a derived class. (Inherited from FlyoutBase) |
| GetAnimationBaseValue(DependencyProperty) |
Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| Hide() |
Closes the flyout. (Inherited from FlyoutBase) |
| OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) |
Called just before a keyboard shortcut (accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling. (Inherited from FlyoutBase) |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback) |
Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject) |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
| ShowAt(DependencyObject, FlyoutShowOptions) |
Shows the flyout placed in relation to the specified element using the specified options. (Inherited from FlyoutBase) |
| ShowAt(FrameworkElement) |
Shows the flyout placed in relation to the specified element. (Inherited from FlyoutBase) |
| TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) |
Attempts to invoke a keyboard shortcut (accelerator). (Inherited from FlyoutBase) |
| UnregisterPropertyChangedCallback(DependencyProperty, Int64) |
Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject) |
Events
| Closed |
Occurs when the flyout is hidden. (Inherited from FlyoutBase) |
| Closing |
Occurs when the flyout starts to be hidden. (Inherited from FlyoutBase) |
| Opened |
Occurs when the flyout is shown. (Inherited from FlyoutBase) |
| Opening |
Occurs before the flyout is shown. (Inherited from FlyoutBase) |