Flyout Class

Summary

A sliding panel control that is hosted in a MetroWindow via a FlyoutsControl. MetroWindow
Namespace
MahApps.Metro.Controls
Base Types
  • HeaderedContentControl
graph BT Type-->Base0["HeaderedContentControl"] Type["Flyout"] class Type type-node

Syntax

[TemplatePart(Name = "PART_Root", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "PART_Header", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "PART_Content", Type = typeof(FrameworkElement))]
public class Flyout : HeaderedContentControl

Attributes

Type Description
TemplatePart
TemplatePart
TemplatePart

Constructors

Name Summary
Flyout()

Events

Name Type Summary
ClosingFinished RoutedEventHandler
IsOpenChanged RoutedEventHandler
OpeningFinished RoutedEventHandler

Fields

Name Constant Value Summary
AllowFocusElementProperty
static
AnimateOnPositionChangeProperty
static
AnimateOpacityProperty
static
AreAnimationsEnabledProperty
static
AutoCloseIntervalProperty
static
CloseButtonIsCancelProperty
static
CloseButtonVisibilityProperty
static
CloseCommandParameterProperty
static
CloseCommandProperty
static
ClosingFinishedEvent
An event that is raised when the closing animation has finished.
static
ExternalCloseButtonProperty
static
FocusedElementProperty
static
IsAutoCloseEnabledProperty
static
IsModalProperty
static
IsOpenChangedEvent
An event that is raised when IsOpen changes.
static
IsOpenProperty
static
IsPinnedProperty
static
OpeningFinishedEvent
An event that is raised when the opening animation has finished.
static
PositionProperty
static
ThemeProperty
static
TitleVisibilityProperty
static

Properties

Name Value Summary
AllowFocusElement bool
Gets or sets a value indicating whether the flyout should try focus an element.
AnimateOnPositionChange bool
Gets/sets whether this flyout uses the open/close animation when changing the Position property. (default is true)
AnimateOpacity bool
Gets/sets whether this flyout animates the opacity of the flyout when opening/closing.
AreAnimationsEnabled bool
AutoCloseInterval long
Gets or sets the time in milliseconds when the flyout should auto close.
CloseButtonIsCancel bool
Gets/sets if the close button is a cancel button in this flyout.
CloseButtonVisibility Visibility
Gets/sets if the close button is visible in this flyout.
CloseCommand ICommand
Gets/sets a command which will be executed if the close button was clicked. Note that this won't execute when IsOpen is set to false.
CloseCommandParameter object
Gets/sets the command parameter which will be passed by the CloseCommand.
ExternalCloseButton MouseButton
Gets/sets the mouse button that closes the flyout on an external mouse click.
FocusedElement FrameworkElement
Gets or sets the focused element.
IsAutoCloseEnabled bool
Gets or sets a value indicating whether the flyout should auto close after AutoCloseInterval has passed.
IsModal bool
Gets/sets whether this flyout is modal.
IsOpen bool
Gets/sets whether this flyout is visible.
IsPinned bool
Gets/sets whether this flyout stays open when the user clicks outside of it.
Position Position
Gets/sets this flyout's position in the FlyoutsControl/MetroWindow.
Theme FlyoutTheme
Gets or sets the theme of this flyout.
TitleVisibility Visibility
Gets/sets if the title is visible in this flyout.

Methods

See Also