FlyoutBase Class
Definition
Represents the base class for flyout controls, such as Flyout and MenuFlyout.
Equivalent WinUI class: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.
public ref class FlyoutBase : DependencyObject
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory, Windows.Foundation.Metadata.CompositionType.Protected, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class FlyoutBase : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory, Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics, 65536, "Windows.Foundation.UniversalApiContract")]
class FlyoutBase : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory, Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics2, 196608, "Windows.Foundation.UniversalApiContract")]
class FlyoutBase : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory, Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics2, 196608, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics3, 262144, "Windows.Foundation.UniversalApiContract")]
class FlyoutBase : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory, Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics2, 196608, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics3, 262144, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics5, 458752, "Windows.Foundation.UniversalApiContract")]
class FlyoutBase : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory, Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics2, 196608, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics3, 262144, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics5, 458752, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics6, 524288, "Windows.Foundation.UniversalApiContract")]
class FlyoutBase : DependencyObject
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory), Windows.Foundation.Metadata.CompositionType.Protected, 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class FlyoutBase : DependencyObject
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory), Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics), 65536, "Windows.Foundation.UniversalApiContract")]
public class FlyoutBase : DependencyObject
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory), Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics2), 196608, "Windows.Foundation.UniversalApiContract")]
public class FlyoutBase : DependencyObject
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory), Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics2), 196608, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics3), 262144, "Windows.Foundation.UniversalApiContract")]
public class FlyoutBase : DependencyObject
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory), Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics2), 196608, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics3), 262144, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics5), 458752, "Windows.Foundation.UniversalApiContract")]
public class FlyoutBase : DependencyObject
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseFactory), Windows.Foundation.Metadata.CompositionType.Protected, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics2), 196608, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics3), 262144, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics5), 458752, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.Primitives.IFlyoutBaseStatics6), 524288, "Windows.Foundation.UniversalApiContract")]
public class FlyoutBase : DependencyObject
Public Class FlyoutBase
Inherits DependencyObject
- Inheritance
- Derived
- Attributes
Windows 10 requirements
Device family |
Windows 10 (introduced in 10.0.10240.0)
|
API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Remarks
FlyoutBase derived classes
FlyoutBase is the parent class for Flyout and MenuFlyout.
XAML attached properties
FlyoutBase is the host service class for a XAML attached property.
In order to support XAML processor access to the attached properties, and also to expose equivalent get and set operations to code, each XAML attached property has a pair of Get and Set accessor methods. Another way to get or set the value in code is to use the dependency property system, calling either GetValue or SetValue and passing the identifier field as the dependency property identifier.
Attached property | Description |
---|---|
AttachedFlyout | Gets or sets the flyout attached to a FrameworkElement.
|
Version history
Windows version | SDK version | Value added |
---|---|---|
1607 | 14393 | AllowFocusOnInteraction |
1607 | 14393 | AllowFocusWhenDisabled |
1607 | 14393 | Closing |
1607 | 14393 | ElementSoundMode |
1607 | 14393 | LightDismissOverlayMode |
1607 | 14393 | Target |
1703 | 15063 | OverlayInputPassThroughElement |
1709 | 16299 | OnProcessKeyboardAccelerators |
1709 | 16299 | TryInvokeKeyboardAccelerator |
1809 | 17763 | AreOpenCloseAnimationsEnabled |
1809 | 17763 | InputDevicePrefersPrimaryCommands |
1809 | 17763 | IsOpen |
1809 | 17763 | ShowAt(DependencyObject,FlyoutShowOptions) |
1809 | 17763 | ShowMode |
1903 | 18362 | IsConstrainedToRootBounds |
1903 | 18362 | ShouldConstrainToRootBounds |
1903 | 18362 | XamlRoot |
Constructors
FlyoutBase() |
Provides base class initialization behavior for FlyoutBase derived classes. Equivalent WinUI constructor: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.FlyoutBase. |
Properties
Attached Properties
AttachedFlyout |
Methods
ClearValue(DependencyProperty) |
Clears the local value of a dependency property. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue. (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. Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.CreatePresenter. |
GetAnimationBaseValue(DependencyProperty) |
Returns any base value established for a dependency property, which would apply in cases where an animation is not active. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue. (Inherited from DependencyObject) |
GetAttachedFlyout(FrameworkElement) |
Gets the flyout associated with the specified element. Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.GetAttachedFlyout. |
GetValue(DependencyProperty) |
Returns the current effective value of a dependency property from a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue. (Inherited from DependencyObject) |
Hide() |
Closes the flyout. Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Hide. |
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. Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.OnProcessKeyboardAccelerators. |
ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if a local value is set. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue. (Inherited from DependencyObject) |
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback) |
Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback. (Inherited from DependencyObject) |
SetAttachedFlyout(FrameworkElement, FlyoutBase) |
Associates the specified flyout with the specified FrameworkElement. Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.SetAttachedFlyout. |
SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property on a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue. (Inherited from DependencyObject) |
ShowAt(DependencyObject, FlyoutShowOptions) |
Shows the flyout placed in relation to the specified element using the specified options. Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.ShowAt. |
ShowAt(FrameworkElement) |
Shows the flyout placed in relation to the specified element. Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.ShowAt. |
ShowAttachedFlyout(FrameworkElement) |
Shows the flyout associated with the specified element, if any. Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.ShowAttachedFlyout. |
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) |
Attempts to invoke a keyboard shortcut (accelerator). Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.TryInvokeKeyboardAccelerator. |
UnregisterPropertyChangedCallback(DependencyProperty, Int64) |
Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback. (Inherited from DependencyObject) |
Events
Closed |
Occurs when the flyout is hidden. Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Closed. |
Closing |
Occurs when the flyout starts to be hidden. Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Closing. |
Opened |
Occurs when the flyout is shown. Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Opened. |
Opening |
Occurs before the flyout is shown. Equivalent WinUI event: Microsoft.UI.Xaml.Controls.Primitives.FlyoutBase.Opening. |