FlyoutBase
FlyoutBase
FlyoutBase
FlyoutBase
Class
Definition
Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Prerelease APIs are identified by a Prerelease label.
[Contains prerelease APIs.]
Represents the base class for flyout controls, such as Flyout and MenuFlyout.
public : class FlyoutBase : DependencyObject, IFlyoutBase, IFlyoutBase2, IFlyoutBase3, IFlyoutBaseOverridespublic class FlyoutBase : DependencyObject, IFlyoutBase, IFlyoutBase2, IFlyoutBase3, IFlyoutBaseOverridesPublic Class FlyoutBase Inherits DependencyObject Implements IFlyoutBase, IFlyoutBase2, IFlyoutBase3, IFlyoutBaseOverrides// This API is not available in Javascript.
- Inheritance
-
FlyoutBaseFlyoutBaseFlyoutBaseFlyoutBase
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Inherited Members
Inherited methods
Inherited properties
Remarks
FlyoutBase derived classes
FlyoutBase is the parent class for Flyout and MenuFlyout.
Constructors
FlyoutBase() FlyoutBase() FlyoutBase() FlyoutBase()
Provides base class initialization behavior for FlyoutBase derived classes.
protected : FlyoutBase()protected FlyoutBase()Protected Sub New()// This API is not available in Javascript.
Properties
AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction
Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.
public : PlatForm::Boolean AllowFocusOnInteraction { get; set; }public bool AllowFocusOnInteraction { get; set; }Public ReadWrite Property AllowFocusOnInteraction As bool// This API is not available in Javascript.
<flyoutAllowFocusOnInteraction="bool"/>
- Value
- PlatForm::Boolean bool bool bool
true if the element gets focus when a user interacts with it; otherwise, false.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
Available starting in Windows 10, version 1607.
AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty
Identifies the AllowFocusOnInteraction dependency property.
public : static DependencyProperty AllowFocusOnInteractionProperty { get; }public static DependencyProperty AllowFocusOnInteractionProperty { get; }Public Static ReadOnly Property AllowFocusOnInteractionProperty As DependencyProperty// This API is not available in Javascript.
The identifier for the AllowFocusOnInteraction dependency property.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled
Gets or sets a value that specifies whether the control can receive focus when it's disabled.
public : PlatForm::Boolean AllowFocusWhenDisabled { get; set; }public bool AllowFocusWhenDisabled { get; set; }Public ReadWrite Property AllowFocusWhenDisabled As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the control can receive focus when it's disabled; otherwise, false.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty
Identifies the AllowFocusWhenDisabled dependency property.
public : static DependencyProperty AllowFocusWhenDisabledProperty { get; }public static DependencyProperty AllowFocusWhenDisabledProperty { get; }Public Static ReadOnly Property AllowFocusWhenDisabledProperty As DependencyProperty// This API is not available in Javascript.
The identifier for the AllowFocusWhenDisabled dependency property.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
AttachedFlyoutProperty AttachedFlyoutProperty AttachedFlyoutProperty AttachedFlyoutProperty
Identifies the FlyoutBase.AttachedFlyout XAML attached property.
public : static DependencyProperty AttachedFlyoutProperty { get; }public static DependencyProperty AttachedFlyoutProperty { get; }Public Static ReadOnly Property AttachedFlyoutProperty As DependencyProperty// This API is not available in Javascript.
The identifier for the FlyoutBase.AttachedFlyout XAML attached property.
ElementSoundMode ElementSoundMode ElementSoundMode ElementSoundMode
Gets or sets a value that specifies the control's preference for whether it plays sounds.
public : ElementSoundMode ElementSoundMode { get; set; }public ElementSoundMode ElementSoundMode { get; set; }Public ReadWrite Property ElementSoundMode As ElementSoundMode// This API is not available in Javascript.
An enumeration value that specifies the control's preference for whether it plays sounds. The default is Default.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
For more info, see Sound in UWP apps.
- See Also
ElementSoundModeProperty ElementSoundModeProperty ElementSoundModeProperty ElementSoundModeProperty
Identifies the ElementSoundMode dependency property.
public : static DependencyProperty ElementSoundModeProperty { get; }public static DependencyProperty ElementSoundModeProperty { get; }Public Static ReadOnly Property ElementSoundModeProperty As DependencyProperty// This API is not available in Javascript.
The identifier for the ElementSoundMode dependency property.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
LightDismissOverlayMode LightDismissOverlayMode LightDismissOverlayMode LightDismissOverlayMode
Gets or sets a value that specifies whether the area outside of a light-dismiss UI is darkened.
public : LightDismissOverlayMode LightDismissOverlayMode { get; set; }public LightDismissOverlayMode LightDismissOverlayMode { get; set; }Public ReadWrite Property LightDismissOverlayMode As LightDismissOverlayMode// This API is not available in Javascript.
- Value
- LightDismissOverlayMode LightDismissOverlayMode LightDismissOverlayMode LightDismissOverlayMode
A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is Auto.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
Transient UI, such as a Flyout or MenuFlyout, closes when you click or tap outside of it. This is called light-dismiss. "Overlay" refers to the area outside of a light-dismiss UI.
By default, the "overlay" is darkened on the Xbox, and not darkened on other devices families. You can set LightDismissOverlayMode to On to make your app darken the "overlay" area on all device families, or set it to Off to not darken the "overlay" area on all device families.
LightDismissOverlayModeProperty LightDismissOverlayModeProperty LightDismissOverlayModeProperty LightDismissOverlayModeProperty
Identifies the LightDismissOverlayMode dependency property.
public : static DependencyProperty LightDismissOverlayModeProperty { get; }public static DependencyProperty LightDismissOverlayModeProperty { get; }Public Static ReadOnly Property LightDismissOverlayModeProperty As DependencyProperty// This API is not available in Javascript.
The identifier for the LightDismissOverlayMode dependency property.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
OverlayInputPassThroughElement OverlayInputPassThroughElement OverlayInputPassThroughElement OverlayInputPassThroughElement
Gets or sets an element that should receive pointer input events even when underneath the flyout's overlay.
public : DependencyObject OverlayInputPassThroughElement { get; set; }public DependencyObject OverlayInputPassThroughElement { get; set; }Public ReadWrite Property OverlayInputPassThroughElement As DependencyObject// This API is not available in Javascript.
The element that should receive pointer input events even when underneath the flyout's overlay.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
OverlayInputPassThroughElementProperty OverlayInputPassThroughElementProperty OverlayInputPassThroughElementProperty OverlayInputPassThroughElementProperty
Identifies the OverlayInputPassThroughElement dependency property.
public : static DependencyProperty OverlayInputPassThroughElementProperty { get; }public static DependencyProperty OverlayInputPassThroughElementProperty { get; }Public Static ReadOnly Property OverlayInputPassThroughElementProperty As DependencyProperty// This API is not available in Javascript.
The identifier for the OverlayInputPassThroughElement dependency property.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Placement Placement Placement Placement
Gets or sets the default placement to be used for the flyout, in relation to its placement target.
public : FlyoutPlacementMode Placement { get; set; }public FlyoutPlacementMode Placement { get; set; }Public ReadWrite Property Placement As FlyoutPlacementMode// This API is not available in Javascript.
<flyoutPlacement="flyoutPlacementModeMemberName" />
A named constant of the enumeration that indicates where the flyout is placed in relation to its placement target. The default is Top.
- See Also
PlacementProperty PlacementProperty PlacementProperty PlacementProperty
Identifies the Placement dependency property.
public : static DependencyProperty PlacementProperty { get; }public static DependencyProperty PlacementProperty { get; }Public Static ReadOnly Property PlacementProperty As DependencyProperty// This API is not available in Javascript.
The identifier for the Placement dependency property.
Target Target Target Target
Gets the element to use as the flyout's placement target.
public : FrameworkElement Target { get; }public FrameworkElement Target { get; }Public ReadOnly Property Target As FrameworkElement// This API is not available in Javascript.
<flyoutTarget="flyoutPlacementTarget" />
The element to use as the flyout's placement target.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
Available starting in Windows 10, version 1607.
Methods
CreatePresenter() CreatePresenter() CreatePresenter() 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.
protected : virtual Control CreatePresenter()protected virtual Control CreatePresenter()Protected Overridable Function CreatePresenter() As Control// This API is not available in Javascript.
Remarks
This method has no base class implementation and must be overridden in a derived class.
GetAttachedFlyout(FrameworkElement) GetAttachedFlyout(FrameworkElement) GetAttachedFlyout(FrameworkElement) GetAttachedFlyout(FrameworkElement)
Gets the flyout associated with the specified element.
public : static FlyoutBase GetAttachedFlyout(FrameworkElement element)public static FlyoutBase GetAttachedFlyout(FrameworkElement element)Public Static Function GetAttachedFlyout(element As FrameworkElement) As FlyoutBase// This API is not available in Javascript.
The element for which to get the associated flyout.
The flyout attached to the specified element.
- See Also
Hide() Hide() Hide() Hide()
Closes the flyout.
public : void Hide()public void Hide()Public Function Hide() As void// This API is not available in Javascript.
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)
Prerelease. 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.
protected : virtual void OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs args)protected virtual void OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs args)Protected Overridable Function OnProcessKeyboardAccelerators(args As ProcessKeyboardAcceleratorEventArgs) As void// This API is not available in Javascript.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Examples
SetAttachedFlyout(FrameworkElement, FlyoutBase) SetAttachedFlyout(FrameworkElement, FlyoutBase) SetAttachedFlyout(FrameworkElement, FlyoutBase) SetAttachedFlyout(FrameworkElement, FlyoutBase)
Associates the specified flyout with the specified FrameworkElement.
public : static void SetAttachedFlyout(FrameworkElement element, FlyoutBase value)public static void SetAttachedFlyout(FrameworkElement element, FlyoutBase value)Public Static Function SetAttachedFlyout(element As FrameworkElement, value As FlyoutBase) As void// This API is not available in Javascript.
The element to associate the flyout with.
The flyout to associate with the specified element.
- See Also
ShowAt(FrameworkElement) ShowAt(FrameworkElement) ShowAt(FrameworkElement) ShowAt(FrameworkElement)
Shows the flyout placed in relation to the specified element.
public : void ShowAt(FrameworkElement placementTarget)public void ShowAt(FrameworkElement placementTarget)Public Function ShowAt(placementTarget As FrameworkElement) As void// This API is not available in Javascript.
- placementTarget
- FrameworkElement FrameworkElement FrameworkElement FrameworkElement
The element to use as the flyout's placement target.
ShowAttachedFlyout(FrameworkElement) ShowAttachedFlyout(FrameworkElement) ShowAttachedFlyout(FrameworkElement) ShowAttachedFlyout(FrameworkElement)
Shows the flyout associated with the specified element, if any.
public : static void ShowAttachedFlyout(FrameworkElement flyoutOwner)public static void ShowAttachedFlyout(FrameworkElement flyoutOwner)Public Static Function ShowAttachedFlyout(flyoutOwner As FrameworkElement) As void// This API is not available in Javascript.
The element for which to show the associated flyout.
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)
Prerelease. Attempts to invoke a keyboard shortcut (accelerator).
public : void TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs args)public void TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs args)Public Function TryInvokeKeyboardAccelerator(args As ProcessKeyboardAcceleratorEventArgs) As void// This API is not available in Javascript.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
Call this method in the OnProcessKeyboardAccelerators override when an accelerator is invoked and you want to influence the default accelerator handling.
Events
Closed Closed Closed Closed
Occurs when the flyout is hidden.
public : event EventHandler Closed<object>public event EventHandler Closed<object>Public Event Closed<object>// This API is not available in Javascript.
<flyout Closed="eventhandler"/>
Closing Closing Closing Closing
Occurs when the flyout starts to be hidden.
public : event TypedEventHandler Closing<FlyoutBase, FlyoutBaseClosingEventArgs>public event TypedEventHandler Closing<FlyoutBase, FlyoutBaseClosingEventArgs>Public Event Closing<FlyoutBase, FlyoutBaseClosingEventArgs>// This API is not available in Javascript.
<flyout Closing="eventhandler"/>
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
Available starting in Windows 10, version 1607.
Opened Opened Opened Opened
Occurs when the flyout is shown.
public : event EventHandler Opened<object>public event EventHandler Opened<object>Public Event Opened<object>// This API is not available in Javascript.
<flyout Opened="eventhandler"/>