BarMenuItem Class

[TemplatePart(Name = "PART_Popup", Type = typeof(Popup))]
[TemplatePart(Name = "PART_PopupContentHost", Type = typeof(ResizablePopupContentHost))]
public class BarMenuItem : MenuItem

public BarMenuItem()

public BarMenuItem(string label)

Parameter	Type	Description
label	string	The text label to display.

public bool CanCloneToRibbonQuickAccessToolBar { get; set; }

Property Value

bool:

true if the control can be cloned to the ribbon quick-access toolbar; otherwise, false. The default value is true.

public bool CanEffectivelyExecute { get; protected set; }

Property Value

bool:

true if the control can effectively execute the Command; otherwise, false.

public bool CanEffectivelyOpenSubMenu { get; protected set; }

Property Value

bool:

true if the control can effectively open its sub-menu; otherwise, false.

public bool CanSelectOnPointerOver { get; set; }

Property Value

bool:

true if the control can focus the menu item on pointer over; otherwise, false.

[Localizability(LocalizationCategory.Text)]
public string Description { get; set; }

Property Value

string:

The extended description of the menu item.

See Also

• UseLargeSize

protected override bool IsEnabledCore { get; }

Property Value

bool:

true if the MenuItem can be selected; otherwise, false.

public bool IsInputGestureTextVisible { get; set; }

Property Value

bool:

true if the input gesture text is allowed to be visible in the user interface; otherwise, false. The default value is true.

[Localizability(LocalizationCategory.NeverLocalize)]
public string Key { get; set; }

Property Value

string:

A string that uniquely identifies the control.

[Localizability(LocalizationCategory.Label)]
public string KeyTipText { get; set; }

Property Value

string:

The key tip text used to access the control.

[Localizability(LocalizationCategory.Label)]
public string Label { get; set; }

Property Value

string:

The text label to display.

public ImageSource LargeImageSource { get; set; }

Property Value

ImageSource:

The ImageSource for a large image.

public ICommand PopupOpeningCommand { get; set; }

Property Value

ICommand:

The ICommand that executes before the menu item's popup is opened, allowing its items to be customized in MVVM scenarios.

public object ScreenTipFooter { get; set; }

Property Value

object:

The screen tip footer content.

public object ScreenTipHeader { get; set; }

Property Value

object:

The screen tip header content.

public ImageSource SmallImageSource { get; set; }

Property Value

ImageSource:

The ImageSource for a small image.

[Localizability(LocalizationCategory.Title)]
public string Title { get; set; }

Property Value

string:

The string title.

public bool UseLargeSize { get; set; }

Property Value

bool:

true if a large size should be used; otherwise, false. The default value is false.

See Also

• Description

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The container element.
item	object	The item.

protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject:

The element used to display a specified item.

protected override bool IsItemItsOwnContainerOverride(object item)

Parameter	Type	Description
item	object	Specified item.

Returns

bool:

true if the item is its own ItemContainer; otherwise, false.

public override void OnApplyTemplate()

protected override void OnClick()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

A MenuItemAutomationPeer for this MenuItem.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The event data for the GotFocus event.

protected override void OnInitialized(EventArgs e)

Parameter	Type	Description
e	EventArgs	The event data for the Initialized event.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	The event data for the IsKeyboardFocusWithinChanged event.

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameter	Type	Description
e	NotifyCollectionChangedEventArgs	The event data for the ItemsChanged event.

protected override void OnKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	The event data for the KeyDown event.

protected virtual void OnKeyTipInvoked(KeyTipInvokedEventArgs e)

Parameter	Type	Description
e	KeyTipInvokedEventArgs	The KeyTipInvokedEventArgs containing data related to this event.

protected virtual void OnKeyTipOpening(KeyTipOpeningEventArgs e)

Parameter	Type	Description
e	KeyTipOpeningEventArgs	The KeyTipOpeningEventArgs containing data related to this event.

protected override void OnKeyUp(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	The KeyEventArgs that contains the event data.

protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains event data.

protected override void OnMouseEnter(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	The event data for the System.Windows.Input.Mouse.MouseEnter event.

protected override void OnMouseLeave(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	The event data for the System.Windows.Input.Mouse.MouseLeave event.

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The event data for the MouseLeftButtonDown event.

protected override void OnMouseRightButtonDown(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The event data for the MouseRightButtonDown event.

protected override void OnMouseRightButtonUp(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The event data for the MouseRightButtonUp event.

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	The event data that describes the property that changed, as well as old and new values.

protected virtual void OnSubmenuOpening(CancelRoutedEventArgs e)

Parameter	Type	Description
e	CancelRoutedEventArgs	The CancelRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnToolTipOpening(ToolTipEventArgs e)

Parameter	Type	Description
e	ToolTipEventArgs	Provides data about the event.

protected override void OnVisualParentChanged(DependencyObject oldParent)

Parameter	Type	Description
oldParent	DependencyObject	Old value of the parent of the visual, or null if the visual did not have a parent.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	Element used to display the specified item.
item	object	Specified item.

public override string ToString()

Returns

string:

The string representation of this object.

protected virtual void UpdateEnabledProperties()

public event EventHandler<CancelRoutedEventArgs> SubmenuOpening

Event Type

EventHandler<CancelRoutedEventArgs>

public static readonly DependencyProperty CanCloneToRibbonQuickAccessToolBarProperty

public static readonly DependencyProperty CanEffectivelyExecuteProperty

public static readonly DependencyProperty CanEffectivelyOpenSubMenuProperty

public static readonly DependencyProperty CanSelectOnPointerOverProperty

public static readonly DependencyProperty DescriptionProperty

public static readonly DependencyProperty IsInputGestureTextVisibleProperty

public static readonly DependencyProperty KeyProperty

public static readonly DependencyProperty KeyTipTextProperty

public static readonly DependencyProperty LabelProperty

public static readonly DependencyProperty LargeImageSourceProperty

public static readonly DependencyProperty PopupOpeningCommandProperty

public static readonly DependencyProperty ScreenTipFooterProperty

public static readonly DependencyProperty ScreenTipHeaderProperty

public static readonly DependencyProperty SmallImageSourceProperty

public static readonly RoutedEvent SubmenuOpeningEvent

public static readonly DependencyProperty TitleProperty

public static readonly DependencyProperty UseLargeSizeProperty