MetroNavigationWindow Class

Summary

A reimplementation of NavigationWindow based on MetroWindow.
Namespace
MahApps.Metro.Controls
Interfaces
  • IUriContext
Base Types
graph BT Type-->Base0["MetroWindow"] click Base0 "/api/MahApps.Metro.Controls/MetroWindow" Base0-->Base1["Window"] Type-.->Interface0["IUriContext"] Type["MetroNavigationWindow"] class Type type-node

Syntax

[ContentProperty(nameof(OverlayContent))]
public class MetroNavigationWindow : MetroWindow, IUriContext

Attributes

Type Description
ContentProperty

Constructors

Events

Name Type Summary
FlyoutsStatusChanged RoutedEventHandler
Inherited from MetroWindow
FragmentNavigation FragmentNavigationEventHandler
Occurs when navigation to a content fragment begins, which occurs immediately, if the desired fragment is in the current content, or after the source XAML content has been loaded, if the desired fragment is in different content.
LoadCompleted LoadCompletedEventHandler
Occurs when content that was navigated to has been loaded, parsed, and has begun rendering.
Navigated NavigatedEventHandler
Occurs when the content that is being navigated to has been found, and is available from the PageContent property, although it may not have completed loading
Navigating NavigatingCancelEventHandler
Occurs when a new navigation is requested.
NavigationFailed NavigationFailedEventHandler
Occurs when an error is raised while navigating to the requested content.
NavigationProgress NavigationProgressEventHandler
Occurs periodically during a download to provide navigation progress information.
NavigationStopped NavigationStoppedEventHandler
Occurs when the StopLoading method is called, or when a new navigation is requested while a current navigation is in progre
WindowTransitionCompleted RoutedEventHandler
Inherited from MetroWindow

Fields

Name Constant Value Summary
FlyoutOverlayBrushProperty
Inherited from MetroWindow
static
FlyoutsProperty
Inherited from MetroWindow
static
FlyoutsStatusChangedEvent
Inherited from MetroWindow
static
GlowBrushProperty
Inherited from MetroWindow
static
IconBitmapScalingModeProperty
Inherited from MetroWindow
static
IconEdgeModeProperty
Inherited from MetroWindow
static
IconOverlayBehaviorProperty
Inherited from MetroWindow
static
IconScalingModeProperty
Inherited from MetroWindow
static
IconTemplateProperty
Inherited from MetroWindow
static
IgnoreTaskbarOnMaximizeProperty
Identifies the IgnoreTaskbarOnMaximize dependency property.
Inherited from MetroWindow
static
IsAnyDialogOpenProperty
Identifies the IsAnyDialogOpen dependency property.
Inherited from MetroWindow
static
IsCloseButtonEnabledProperty
Inherited from MetroWindow
static
IsCloseButtonEnabledWithDialogProperty
Identifies the IsCloseButtonEnabledWithDialog dependency property.
Inherited from MetroWindow
static
IsMaxRestoreButtonEnabledProperty
Inherited from MetroWindow
static
IsMinButtonEnabledProperty
Inherited from MetroWindow
static
IsWindowDraggableProperty
Inherited from MetroWindow
static
KeepBorderOnMaximizeProperty
DependencyProperty for KeepBorderOnMaximize.
Inherited from MetroWindow
static
LeftWindowCommandsOverlayBehaviorProperty
Inherited from MetroWindow
static
LeftWindowCommandsProperty
Inherited from MetroWindow
static
MetroDialogOptionsProperty
Inherited from MetroWindow
static
NonActiveBorderBrushProperty
Inherited from MetroWindow
static
NonActiveGlowBrushProperty
Inherited from MetroWindow
static
NonActiveWindowTitleBrushProperty
Inherited from MetroWindow
static
OverlayBrushProperty
Inherited from MetroWindow
static
OverlayContentProperty
static
OverlayFadeInProperty
Identifies the OverlayFadeIn dependency property.
Inherited from MetroWindow
static
OverlayFadeOutProperty
Identifies the OverlayFadeOut dependency property.
Inherited from MetroWindow
static
OverlayOpacityProperty
Inherited from MetroWindow
static
OverrideDefaultWindowCommandsBrushProperty
Inherited from MetroWindow
static
PageContentProperty
static
ResizeBorderThicknessProperty
DependencyProperty for ResizeBorderThickness.
Inherited from MetroWindow
static
RightWindowCommandsOverlayBehaviorProperty
Inherited from MetroWindow
static
RightWindowCommandsProperty
Inherited from MetroWindow
static
SaveWindowPositionProperty
Inherited from MetroWindow
static
ShowCloseButtonProperty
Inherited from MetroWindow
static
ShowDialogsOverTitleBarProperty
Inherited from MetroWindow
static
ShowIconOnTitleBarProperty
Inherited from MetroWindow
static
ShowMaxRestoreButtonProperty
Inherited from MetroWindow
static
ShowMinButtonProperty
Inherited from MetroWindow
static
ShowSystemMenuOnRightClickProperty
Inherited from MetroWindow
static
ShowSystemMenuProperty
Inherited from MetroWindow
static
ShowTitleBarProperty
Inherited from MetroWindow
static
TitleAlignmentProperty
Inherited from MetroWindow
static
TitleBarHeightProperty
Inherited from MetroWindow
static
TitleCharacterCasingProperty
Inherited from MetroWindow
static
TitleForegroundProperty
Inherited from MetroWindow
static
TitleTemplateProperty
Inherited from MetroWindow
static
TryToBeFlickerFreeProperty
DependencyProperty for TryToBeFlickerFree.
Inherited from MetroWindow
static
UseNoneWindowStyleProperty
Inherited from MetroWindow
static
WindowButtonCommandsOverlayBehaviorProperty
Inherited from MetroWindow
static
WindowButtonCommandsProperty
Inherited from MetroWindow
static
WindowPlacementSettingsProperty
Inherited from MetroWindow
static
WindowTitleBrushProperty
Inherited from MetroWindow
static
WindowTransitionCompletedEvent
Inherited from MetroWindow
static
WindowTransitionsEnabledProperty
Inherited from MetroWindow
static

Properties

Name Value Summary
BackStack IEnumerable
Gets an IEnumerable that you use to enumerate the entries in back navigation history for a NavigationWindow.
CanGoBack bool
Gets a value that indicates whether there is at least one entry in back navigation history.
CanGoForward bool
Gets a value that indicates whether there is at least one entry in forward navigation history.
FlyoutOverlayBrush Brush
Gets or sets the brush used for the Flyouts overlay.
Inherited from MetroWindow
Flyouts FlyoutsControl
Gets/sets the FlyoutsControl that hosts the window's flyouts.
Inherited from MetroWindow
ForwardStack IEnumerable
Gets an IEnumerable that you use to enumerate the entries in back navigation history for a NavigationWindow.
GlowBrush Brush
Gets/sets the brush used for the Window's glow.
Inherited from MetroWindow
IconBitmapScalingMode BitmapScalingMode
Gets/sets bitmap scaling mode of the titlebar icon.
Inherited from MetroWindow
IconEdgeMode EdgeMode
Gets/sets edge mode of the titlebar icon.
Inherited from MetroWindow
IconOverlayBehavior OverlayBehavior
Inherited from MetroWindow
IconScalingMode MultiFrameImageMode
Gets/sets icon scaling mode of the titlebar.
Inherited from MetroWindow
IconTemplate DataTemplate
Gets/sets the icon content template to show a custom icon.
Inherited from MetroWindow
IgnoreTaskbarOnMaximize bool
Defines if the Taskbar should be ignored when maximizing a Window. This only works with WindowStyle = None.
Inherited from MetroWindow
IsAnyDialogOpen bool
Gets whether one or more dialogs are shown.
Inherited from MetroWindow
IsCloseButtonEnabled bool
Gets/sets if the close button is enabled.
Inherited from MetroWindow
IsCloseButtonEnabledWithDialog bool
Gets or sets whether if the close button should be enabled or not if a dialog is shown.
Inherited from MetroWindow
IsMaxRestoreButtonEnabled bool
Gets/sets if the max/restore button is enabled.
Inherited from MetroWindow
IsMinButtonEnabled bool
Gets/sets if the min button is enabled.
Inherited from MetroWindow
IsWindowDraggable bool
Inherited from MetroWindow
KeepBorderOnMaximize bool
Gets/sets if the border thickness value should be kept on maximize if the MaxHeight/MaxWidth of the window is less than the monitor resolution.
Inherited from MetroWindow
LeftWindowCommands WindowCommands
Gets/sets the left window commands that hosts the user commands.
Inherited from MetroWindow
LeftWindowCommandsOverlayBehavior WindowCommandsOverlayBehavior
Inherited from MetroWindow
LogicalChildren IEnumerator
Inherited from MetroWindow
MetroDialogOptions MetroDialogSettings
Inherited from MetroWindow
NavigationService NavigationService
Gets the NavigationService that is used by this MetroNavigationWindow to provide navigation services to its content.
NonActiveBorderBrush Brush
Gets/sets the brush used for the Window's non-active border.
Inherited from MetroWindow
NonActiveGlowBrush Brush
Gets/sets the brush used for the Window's non-active glow.
Inherited from MetroWindow
NonActiveWindowTitleBrush Brush
Gets/sets the brush used for the Window's non-active title bar.
Inherited from MetroWindow
OverlayBrush Brush
Gets/sets the brush used for the dialog overlay.
Inherited from MetroWindow
OverlayContent object
OverlayFadeIn Storyboard
Gets or sets the overlay fade in storyboard.
Inherited from MetroWindow
OverlayFadeOut Storyboard
Gets or sets the overlay fade out storyboard.
Inherited from MetroWindow
OverlayOpacity double
Gets/sets the opacity used for the dialog overlay.
Inherited from MetroWindow
OverrideDefaultWindowCommandsBrush Brush
Allows easy handling of window commands brush. Theme is also applied based on this brush.
Inherited from MetroWindow
PageContent object
ResizeBorderThickness Thickness
Gets or sets resize border thickness. This enables animation, styling, binding, etc...
Inherited from MetroWindow
RightWindowCommands WindowCommands
Gets/sets the right window commands that hosts the user commands.
Inherited from MetroWindow
RightWindowCommandsOverlayBehavior WindowCommandsOverlayBehavior
Inherited from MetroWindow
SaveWindowPosition bool
Gets/sets whether the window will save it's position between loads.
Inherited from MetroWindow
ShowCloseButton bool
Gets or sets whether if the close button is visible.
Inherited from MetroWindow
ShowDialogsOverTitleBar bool
Get/sets whether dialogs show over the title bar.
Inherited from MetroWindow
ShowIconOnTitleBar bool
Get/sets whether the titlebar icon is visible or not.
Inherited from MetroWindow
ShowMaxRestoreButton bool
Gets or sets whether if the maximize/restore button is visible and the maximize/restore system menu is enabled.
Inherited from MetroWindow
ShowMinButton bool
Gets or sets whether if the minimize button is visible and the minimize system menu is enabled.
Inherited from MetroWindow
ShowSystemMenu bool
Gets or sets a value that indicates whether the system menu should popup with left mouse click on the window icon.
Inherited from MetroWindow
ShowSystemMenuOnRightClick bool
Gets or sets a value that indicates whether the system menu should popup with right mouse click if the mouse position is on title bar or on the entire window if it has no title bar (and no title bar height).
Inherited from MetroWindow
ShowTitleBar bool
Gets/sets whether the TitleBar is visible or not.
Inherited from MetroWindow
Source Uri
Gets or sets the uniform resource identifier (URI) of the current content, or the URI of new content that is currently being navigated to.
TitleAlignment HorizontalAlignment
Gets/sets the title horizontal alignment.
Inherited from MetroWindow
TitleBarHeight int
Gets/sets the TitleBar's height.
Inherited from MetroWindow
TitleCharacterCasing CharacterCasing
Character casing of the title
Inherited from MetroWindow
TitleForeground Brush
Gets/sets the brush used for the titlebar's foreground.
Inherited from MetroWindow
TitleTemplate DataTemplate
Gets/sets the title content template to show a custom title.
Inherited from MetroWindow
TryToBeFlickerFree bool
Gets or sets wether the resizing of the window should be tried in a way that does not cause flicker/jitter, especially when resizing from the left side.
Inherited from MetroWindow
UseNoneWindowStyle bool
Gets/sets whether the WindowStyle is None or not.
Inherited from MetroWindow
WindowButtonCommands WindowButtonCommands
Gets/sets the window button commands that hosts the min/max/close commands.
Inherited from MetroWindow
WindowButtonCommandsOverlayBehavior OverlayBehavior
Inherited from MetroWindow
WindowPlacementSettings IWindowPlacementSettings
Inherited from MetroWindow
WindowTitleBrush Brush
Gets/sets the brush used for the Window's title bar.
Inherited from MetroWindow
WindowTransitionsEnabled bool
Gets/sets whether the window's entrance transition animation is enabled.
Inherited from MetroWindow

Methods

Name Value Summary
AddBackEntry(CustomContentState) void
Adds an entry to back navigation history that contains a CustomContentState object.
GetWindowPlacementSettings() IWindowPlacementSettings
Gets the window placement settings (can be overwritten).
Inherited from MetroWindow
GoBack() void
Navigates to the most recent item in back navigation history.
GoForward() void
Navigates to the most recent item in forward navigation history.
HideOverlay() void
Inherited from MetroWindow
HideOverlayAsync() Task
Begins to hide the MetroWindow's overlay effect.
Inherited from MetroWindow
IsOverlayVisible() bool
Inherited from MetroWindow
Navigate(object, object) bool
Navigates asynchronously to content that is contained by an object, and passes an object that contains data to be used for processing during navigation.
Navigate(object) bool
Navigates asynchronously to content that is contained by an object.
Navigate(Uri, object) bool
Navigates asynchronously to source content located at a uniform resource identifier (URI), and pass an object that contains data to be used for processing during navigation.
Navigate(Uri) bool
Navigates asynchronously to content that is specified by a uniform resource identifier (URI).
OnApplyTemplate() void
Inherited from MetroWindow
OnClosing(CancelEventArgs) void
Inherited from MetroWindow
OnCreateAutomationPeer() AutomationPeer
Creates AutomationPeer (UIElement.OnCreateAutomationPeer)
Inherited from MetroWindow
RemoveBackEntry() JournalEntry
Removes the most recent journal entry from back history.
ResetStoredFocus() void
Clears the stored element which would get the focus after closing a dialog.
Inherited from MetroWindow
ShowOverlay() void
Inherited from MetroWindow
ShowOverlayAsync() Task
Begins to show the MetroWindow's overlay effect.
Inherited from MetroWindow
StopLoading() void
Stops further downloading of content for the current navigation request.
StoreFocus(IInputElement) void
Stores the given element, or the last focused element via FocusManager, for restoring the focus after closing a dialog.
Inherited from MetroWindow

Extension Methods

Name Value Summary
GetCurrentDialogAsync<TDialog>() Task<TDialog>
Gets the current shown dialog in async way.
HideMetroDialogAsync(BaseMetroDialog, MetroDialogSettings) Task
Hides a visible Metro Dialog instance.
ShowInputAsync(string, string, MetroDialogSettings) Task<string>
Creates a InputDialog inside of the current window.
ShowLoginAsync(string, string, LoginDialogSettings) Task<LoginDialogData>
Creates a LoginDialog inside of the current window.
ShowMessageAsync(string, string, MessageDialogStyle, MetroDialogSettings) Task<MessageDialogResult>
Creates a MessageDialog inside of the current window.
ShowMetroDialogAsync(BaseMetroDialog, MetroDialogSettings) Task
Adds a Metro Dialog instance to the specified window and makes it visible asynchronously. If you want to wait until the user has closed the dialog, use WaitUntilUnloadedAsync()

You have to close the resulting dialog yourself with HideMetroDialogAsync(MetroWindow, BaseMetroDialog, MetroDialogSettings).

ShowMetroDialogAsync<TDialog>(MetroDialogSettings) Task<TDialog>
Adds a Metro Dialog instance of the given type to the specified window and makes it visible asynchronously. If you want to wait until the user has closed the dialog, use WaitUntilUnloadedAsync()

You have to close the resulting dialog yourself with HideMetroDialogAsync(MetroWindow, BaseMetroDialog, MetroDialogSettings).

ShowModalInputExternal(string, string, MetroDialogSettings) string
Creates a InputDialog outside of the current window.
ShowModalLoginExternal(string, string, LoginDialogSettings) LoginDialogData
Creates a LoginDialog outside of the current window.
ShowModalMessageExternal(string, string, MessageDialogStyle, MetroDialogSettings) MessageDialogResult
Creates a MessageDialog ouside of the current window.
ShowProgressAsync(string, string, bool, MetroDialogSettings) Task<ProgressDialogController>
Creates a ProgressDialog inside of the current window.