The requested page is not available for the requested platform. You are viewing the content for Default platform.

HamburgerMenu Members

Represents a collapsible navigation menu that displays a stack of navigation buttons. Supports regular buttons, sub-menus, hyperlinks, check and radio buttons.

Constructors

Name Description
HamburgerMenu()

Initializes a new instance of the HamburgerMenu class with the default settings.

Fields

Name Description
AllowCustomizingWindowTitleProperty

Identifies the HamburgerMenu.AllowCustomizingWindowTitle dependency property.

AvailableViewStatesProperty

Identifies the HamburgerMenu.AvailableViewStates dependency property.

BottomBarItemTemplateProperty

Identifies the HamburgerMenu.BottomBarItemTemplate dependency property.

BottomBarItemTemplateSelectorProperty

Identifies the HamburgerMenu.BottomBarItemTemplateSelector dependency property.

BottomBarItemsSourceProperty

Identifies the HamburgerMenu.BottomBarItemsSource dependency property.

CompactOverlayStateFrameThresholdProperty

Identifies the HamburgerMenu.CompactOverlayStateFrameThreshold dependency property.

CompactWidthProperty

Identifies the HamburgerMenu.CompactWidth dependency property.

HeaderHeightProperty

Identifies the HamburgerMenu.HeaderHeight dependency property.

HeaderPaddingProperty

Identifies the HamburgerMenu.HeaderPadding dependency property.

HeaderProperty

Identifies the HamburgerMenu.Header dependency property.

HeaderTemplateProperty

Identifies the HamburgerMenu.HeaderTemplate dependency property.

HeaderTemplateSelectorProperty

Identifies the HamburgerMenu.HeaderTemplateSelector dependency property.

HideMenuOnUnselectedPage

Obsolete. Gets or sets whether the menu is automatically hidden when the navigated page is not represented in the menu by a navigation button.

HideMenuWhenActivePageItemNotFoundProperty

Identifies the HamburgerMenu.HideMenuWhenActivePageItemNotFound dependency property.

IsInitiallyCompactProperty

Identifies the HamburgerMenu.IsInitiallyCompact dependency property.

IsMenuVisibleProperty

Identifies the HamburgerMenu.IsMenuVisible dependency property.

IsMobileStatusBarVisibleProperty

Identifies the HamburgerMenu.IsMobileStatusBarVisible dependency property.

ItemTemplateProperty

Identifies the HamburgerMenu.ItemTemplate dependency property.

ItemTemplateSelectorProperty

Identifies the HamburgerMenu.ItemTemplateSelector dependency property.

ItemsSourceProperty

Identifies the HamburgerMenu.ItemsSource dependency property.

MinimizedFlyoutStateFrameThresholdProperty

Identifies the HamburgerMenu.MinimizedFlyoutStateFrameThreshold dependency property.

MobileStatusBarBackgroundProperty

Identifies the HamburgerMenu.MobileStatusBarBackground dependency property.

MobileStatusBarForegroundProperty

Identifies the HamburgerMenu.MobileStatusBarForeground dependency property.

SelectedItemProperty

Identifies the HamburgerMenu.SelectedItem dependency property.

ShowMenuOnEmptySpaceBarClickProperty

Identifies the HamburgerMenu.ShowMenuOnEmptySpaceBarClick dependency property.

SyncWithActivePageProperty

Identifies the HamburgerMenu.SyncWithActivePage dependency property.

WindowTitleProperty

Identifies the HamburgerMenu.WindowTitle dependency property.

WindowTitleSettingsProperty

Identifies the HamburgerMenu.WindowTitleSettings dependency property.

Properties

Name Description
AllowCustomizingWindowTitle

Gets or sets whether it is allowed to customize the window title.

AvailableViewStates

Gets or sets whether the menu can be displayed in the Flyout, Overlay and/or Inline state.

BottomBarItemTemplate

Gets or sets the data template used to render each item in the menu's bottom bar from the data source.

BottomBarItemTemplateSelector

Gets or sets a custom data template selection logic for items in the menu's bottom bar.

BottomBarItems

Provides access to a collection of objects that represent Bottom Bar items.

BottomBarItemsSource

Gets or sets an object that represents a source of items for the menu's bottom bar.

CompactOverlayStateFrameThreshold

Gets or sets the window width, in pixels, at which the menu is automatically displayed in the Overlay state. This property supports the adaptive layout.

CompactWidth

Gets or sets the menu pane width, in pixels, in its compact display mode.

Header

Gets or sets the menu header displayed next to the hamburger button.

HeaderHeight

Gets or sets the height of the menu header.

HeaderPadding

Gets or sets the outer margin of the menu header.

HeaderTemplate

Gets or sets the data template used to render the menu header.

HeaderTemplateSelector

Gets or sets a custom data template selection logic to render the menu header.

HideMenuWhenActivePageItemNotFound

Gets or sets whether the menu is automatically hidden when the navigated page is not represented in the Main Menu by a navigation button.

IsInitiallyCompact

Gets or sets whether the menu is initially displayed in the compact mode.

IsMenuVisible

Gets or sets whether the menu is visible.

IsMobileStatusBarVisible

Gets or sets whether the status bar for the window (app view) is shown.

ItemTemplate

Gets or sets the data template used to render each item from the data source.

ItemTemplateSelector

Gets or sets a custom data template selection logic.

Items

Provides access to a collection of objects that represent Main Menu items.

ItemsSource

Gets or sets an object that represents a source of items for the menu.

MinimizedFlyoutStateFrameThreshold

Gets or sets the window width, in pixels, at which the menu is automatically displayed in the Flyout state. This property supports the adaptive layout.

MobileStatusBarBackground

Gets or sets the background color of the status bar. The alpha channel of the color is not used.

MobileStatusBarForeground

Gets or sets the foreground color of the status bar. The alpha channel of the color is not used.

SelectedItem

Gets or sets the menu button which is currently selected.

ShowMenuOnEmptySpaceBarClick

Gets or sets whether the menu displayed in the compact mode can be expanded with a click on an empty space.

SyncWithActivePage

Gets or sets whether the button selection in the menu is automatically synchronized with the navigated page.

WindowTitle

Gets or sets the window title.

WindowTitleSettings

Gets or sets the window title settings, such as the background and foreground colors.

Methods

Name Description
Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) Determines whether the specified object instances are considered equal.
(Inherited from Object)
GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetType() Gets the Type of the current instance.
(Inherited from Object)
MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
ReferenceEquals(Object, Object) Determines whether the specified Object instances are the same instance.
(Inherited from Object)
ToString() Returns a string that represents the current object.
(Inherited from Object)

Events

Name Description
ContextMenuClosed

Occurs after the context menu has been closed.

ContextMenuOpened

Occurs after the context menu has been opened.

ContextMenuOpening

Occurs before the context menu is opened.

See Also