C# Class MahApps.Metro.Controls.HamburgerMenu

The HamburgerMenu is based on a SplitView control. By default it contains a HamburgerButton and a ListView to display menu items.
Show file Open project: MahApps/MahApps.Metro Class Usage Examples

Public Properties

Property Type Description
CompactPaneLengthProperty System.Windows.DependencyProperty
ContentTransitionProperty System.Windows.DependencyProperty
DisplayModeProperty System.Windows.DependencyProperty
HamburgerHeightProperty System.Windows.DependencyProperty
HamburgerMarginProperty System.Windows.DependencyProperty
HamburgerMenuTemplateProperty System.Windows.DependencyProperty
HamburgerWidthProperty System.Windows.DependencyProperty
IsPaneOpenProperty System.Windows.DependencyProperty
ItemTemplateProperty System.Windows.DependencyProperty
ItemsSourceProperty System.Windows.DependencyProperty
OpenPaneLengthProperty System.Windows.DependencyProperty
OptionsItemTemplateProperty System.Windows.DependencyProperty
OptionsItemsSourceProperty System.Windows.DependencyProperty
OptionsVisibilityProperty System.Windows.DependencyProperty
PaneBackgroundProperty System.Windows.DependencyProperty
PanePlacementProperty System.Windows.DependencyProperty

Public Methods

Method Description
HamburgerMenu ( ) : System.Windows

Initializes a new instance of the HamburgerMenu class.
OnApplyTemplate ( ) : void

Override default OnApplyTemplate to capture children controls

Private Methods

Method Description
ButtonsListView_ItemClick ( object sender, System.Windows.Input.MouseButtonEventArgs e ) : void
HamburgerButton_Click ( object sender, RoutedEventArgs e ) : void
OptionsListView_ItemClick ( object sender, System.Windows.Input.MouseButtonEventArgs e ) : void

Method Details

HamburgerMenu() public method

Initializes a new instance of the HamburgerMenu class.
public HamburgerMenu ( ) : System.Windows
return System.Windows

OnApplyTemplate() public method

Override default OnApplyTemplate to capture children controls
public OnApplyTemplate ( ) : void
return void

Property Details

CompactPaneLengthProperty public static property

Identifies the CompactPaneLength dependency property.
public static DependencyProperty,System.Windows CompactPaneLengthProperty
return System.Windows.DependencyProperty

ContentTransitionProperty public static property

public static DependencyProperty,System.Windows ContentTransitionProperty
return System.Windows.DependencyProperty

DisplayModeProperty public static property

Identifies the DisplayMode dependency property.
public static DependencyProperty,System.Windows DisplayModeProperty
return System.Windows.DependencyProperty

HamburgerHeightProperty public static property

Identifies the HamburgerHeight dependency property.
public static DependencyProperty,System.Windows HamburgerHeightProperty
return System.Windows.DependencyProperty

HamburgerMarginProperty public static property

Identifies the HamburgerMargin dependency property.
public static DependencyProperty,System.Windows HamburgerMarginProperty
return System.Windows.DependencyProperty

HamburgerMenuTemplateProperty public static property

Identifies the HamburgerMenuTemplate dependency property.
public static DependencyProperty,System.Windows HamburgerMenuTemplateProperty
return System.Windows.DependencyProperty

HamburgerWidthProperty public static property

Identifies the HamburgerWidth dependency property.
public static DependencyProperty,System.Windows HamburgerWidthProperty
return System.Windows.DependencyProperty

IsPaneOpenProperty public static property

Identifies the IsPaneOpen dependency property.
public static DependencyProperty,System.Windows IsPaneOpenProperty
return System.Windows.DependencyProperty

ItemTemplateProperty public static property

Identifies the ItemTemplate dependency property.
public static DependencyProperty,System.Windows ItemTemplateProperty
return System.Windows.DependencyProperty

ItemsSourceProperty public static property

Identifies the ItemsSource dependency property.
public static DependencyProperty,System.Windows ItemsSourceProperty
return System.Windows.DependencyProperty

OpenPaneLengthProperty public static property

Identifies the OpenPaneLength dependency property.
public static DependencyProperty,System.Windows OpenPaneLengthProperty
return System.Windows.DependencyProperty

OptionsItemTemplateProperty public static property

Identifies the OptionsItemTemplate dependency property.
public static DependencyProperty,System.Windows OptionsItemTemplateProperty
return System.Windows.DependencyProperty

OptionsItemsSourceProperty public static property

Identifies the OptionsItemsSource dependency property.
public static DependencyProperty,System.Windows OptionsItemsSourceProperty
return System.Windows.DependencyProperty

OptionsVisibilityProperty public static property

Identifies the OptionsVisibility dependency property.
public static DependencyProperty,System.Windows OptionsVisibilityProperty
return System.Windows.DependencyProperty

PaneBackgroundProperty public static property

Identifies the PaneBackground dependency property.
public static DependencyProperty,System.Windows PaneBackgroundProperty
return System.Windows.DependencyProperty

PanePlacementProperty public static property

Identifies the PanePlacement dependency property.
public static DependencyProperty,System.Windows PanePlacementProperty
return System.Windows.DependencyProperty