dotnet-api
- C1.WPF.Menu Assembly
  - C1.WPF.Menu

C1.WPF.Menu.C1MenuItem

C1MenuItem Class

Represents a selectable item inside a C1Menu control.

Inheritance

object

C1MenuItem

C1TilesMenuItem

Implements

INotifyPropertyChanged

Namespace: C1.WPF.Menu

Assembly: C1.WPF.Menu.dll

Syntax

[StyleTypedProperty(Property = "OpenIconStyle", StyleTargetType = typeof(ContentControl))]
[StyleTypedProperty(Property = "PopupStyle", StyleTargetType = typeof(C1PopupBorder))]
[StyleTypedProperty(Property = "SeparatorStyle", StyleTargetType = typeof(C1MenuSeparator))]
[StyleTypedProperty(Property = "GroupStyle", StyleTargetType = typeof(C1MenuGroup))]
[StyleTypedProperty(Property = "MenuStyle", StyleTargetType = typeof(C1MenuList))]
[TemplatePart(Name = "MenuList", Type = typeof(C1MenuList))]
[TemplatePart(Name = "HeaderPanel", Type = typeof(Grid))]
[TemplatePart(Name = "OpenIcon", Type = typeof(ContentControl))]
[TemplatePart(Name = "MenuIcon", Type = typeof(ContentControl))]
[TemplatePart(Name = "CheckIcon", Type = typeof(C1CheckBox))]
[TemplatePart(Name = "SubItemsPopup", Type = typeof(C1Popup))]
[TemplateVisualState(Name = "Opened", GroupName = "OpenedStates")]
[TemplateVisualState(Name = "Closed", GroupName = "OpenedStates")]
[TemplateVisualState(Name = "Highlighted", GroupName = "HighlightedStates")]
[TemplateVisualState(Name = "NonHighlighted", GroupName = "HighlightedStates")]
[TemplateVisualState(Name = "Indented", GroupName = "IndentedStates")]
[TemplateVisualState(Name = "NonIndented", GroupName = "IndentedStates")]
public class C1MenuItem : C1HierarchicalPresenter, INotifyPropertyChanged

Constructors

Name	Description
C1MenuItem()	Initializes a new instance of the C1MenuItem class.

Fields

Name	Description
CommandParameterProperty	Identifies the CommandParameter dependency property.
CommandProperty	Identifies the Command dependency property.
GroupNameProperty	Identifies the GroupName dependency property.
GroupStyleProperty	Identifies the GroupStyle dependency property.
HighlightedBackgroundProperty	Identifies the HighlightedBackground dependency property.
HotKeyProperty	Identifies the HotKey dependency property.
IconProperty	Identifies the Icon dependency property.
IconTemplateProperty	Identifies the IconTemplate dependency property.
IndentBackgroundProperty	Identifies the IndentBackground dependency property.
InputGestureTextProperty	Identifies the InputGestureText dependency property.
IsCheckableProperty	Identifies the IsCheckable dependency property.
IsCheckedProperty	Identifies the IsChecked dependency property.
IsHighlightSupportedProperty	Identifies the IsHighlightSupported dependency property.
IsHighlightedProperty	Identifies the IsHighlighted dependency property.
IsIndentedProperty	Identifies the IsIndented dependency property.
IsSubmenuOpenProperty	Identifies the IsSubmenuOpen dependency property.
IsSubmenuOpenVisualProperty	Identifies the IsSubmenuOpenVisual dependency property.
MenuStyleProperty	Identifies the MenuStyle dependency property.
OpenIconStyleProperty	Identifies the OpenIconStyle dependency property.
OpenIconTemplateProperty	Identifies the OpenIconTemplate dependency property.
OpenedBackgroundProperty	Identifies the OpenedBackground dependency property.
PopupStyleProperty	Identifies the PopupStyle dependency property.
SeparatorStyleProperty	Identifies the SeparatorStyle dependency property.
ShowOpenIconProperty	Identifies the ShowOpenIcon dependency property.
SubMenuMaxHeightProperty	Identifies the SubMenuMaxHeight dependency property.
TextAlignmentProperty	Identifies the TextAlignment dependency property.
TextDecorationsProperty	Identifies the TextDecorations dependency property.
TextWrappingProperty	Identifies the TextWrapping dependency property.

Properties

Name	Description
Command	Gets or sets the command to invoke when this button is pressed.
CommandParameter	Gets or sets the parameter to pass to the Command property.
GroupName	Gets or sets the name that specifies which MenuItems are mutually exclusive (when checkable).
GroupStyle	Gets or sets the style of the group items.
HasContent	Gets whether the menu item has any content.
HighlightedBackground	Gets or sets the Brush used to highlight the menu item.
HotKey	Gets or sets the text of the hotkey that will call the command tied to the specified item.
HotKeyVisibility	Gets the visibility of the InputGestureText.
Icon	Gets or sets the icon that appears in a C1MenuItem.
IconTemplate	Gets or sets the template of the icon.
IndentBackground	Gets or sets the brush used to paint the Indent band at the left.
Index	Gets the index of this C1MenuItem in its parent items collection.
InputGestureText	Gets or sets the text describing an input gesture that will call the command tied to the specified item.
IsCheckable	Gets or sets a value that indicates whether a C1MenuItem can be checked.
IsChecked	Gets or sets a value that indicates whether the C1MenuItem is checked.
IsHighlightSupported	Gets or sets the bool value determining whether menu item should support highlighted state. The default value is True.
IsHighlighted	Gets or sets a value that indicates whether a C1MenuItem is highlighted.
IsIndented	Gets or sets whether the Indent band is displayed.
IsSubmenuOpen	Gets or sets a value that indicates whether the submenu of the C1MenuItem is open.
IsSubmenuOpenVisual	Gets or sets a value that indicates whether the submenu of the C1MenuItem is open. This is used for visual purposes only.
Level	Gets the nesting level.
Menu	Gets the top level menu.
MenuList	Gets the parent menu list.
MenuStyle	Gets or sets the style aplied to the sub-menus.
OpenIconStyle	Gets or sets the style of the open icon.
OpenIconTemplate	Gets or sets the template of the icon used to show this item has a sub-menu.
OpenIconVisibility	Gets the visibility of the open icon.
OpenedBackground	Gets or sets the Brush used in a menu item when this item is opened.
ParentItem	Gets the parent menu item.
PopupStyle	Gets or sets the style of the popup.
SeparatorStyle	Gets or sets the style of the separator items.
ShowOpenIcon	Gets or sets whether the open icon is displayed, provided the sub menu has items.
SubMenuMaxHeight	Gets or sets a value that indicates the MaxHeight of the SubMenu.
TextAlignment	Gets or sets a value that indicates the horizontal alignment of text content in the Header.
TextDecorations	Gets or sets a TextDecorationCollection that contains the effects to apply to the text of the Header.
TextWrapping	Gets or sets a value that indicates how any text should be wrapped in the Header.

Methods

Name	Description
ChangeVisualStateHighlighted(bool)	Updates the current visual state of the Highlighted visual state group to match the object's properties.
ChangeVisualStateIndented(bool)	Updates the current visual state of the Indented visual state group to match the object's properties.
ChangeVisualStateOpened(bool)	Updates the current visual state of the Opened visual state group to match the object's properties.
Dispose(bool)
OnAccessKey(AccessKeyEventArgs)
OnApplyTemplate()
OnChecked(SourcedEventArgs)	Responds to a check item action by raising a Checked event.
OnClick(SourcedEventArgs)	Responds to a click action by raising a Click event.
OnItemsChanged(NotifyCollectionChangedEventArgs)
OnMouseEnter(object, C1InputEventArgs)	Called when the mouse pointer enters the bounds of the header element.
OnMouseLeave(object, C1InputEventArgs)	Called when the mouse pointer leaves the bounds of the header element.
OnMouseRightButtonDown(MouseButtonEventArgs)	Called before the System.Windows.UIElement.MouseRightButtonDown event occurs.
OnPropertyChanged(string)	Called when a property changed.
OnPropertyChanged(DependencyPropertyChangedEventArgs)	OnPropertyChanged
OnSubmenuClosed(SourcedEventArgs)	Responds to a closed item action by raising a SubmenuClosed event.
OnSubmenuClosing(CancelSourceEventArgs)	Responds to a close item action by raising a SubmenuClosing event.
OnSubmenuOpened(SourcedEventArgs)	Responds to an open item action by raising a SubmenuOpened event.
OnSubmenuOpening(CancelSourceEventArgs)	Responds to an open item action by raising a SubmenuOpening event.
OnTapped(object, C1TappedEventArgs)	Called when the view is tapped.
OnUnchecked(SourcedEventArgs)	Responds to an uncheck item action by raising a Unchecked event.

Events

Name	Description
Checked	Occurs when a C1MenuItem is checked.
Click	Occurs when the C1MenuItem is clicked.
PropertyChanged	Occurs when a property changed.
SubmenuClosed	Occurs when the state of the IsSubmenuOpen property changes to false.
SubmenuClosing	Occurs when a submenu is closing.
SubmenuOpened	Occurs when the state of the IsSubmenuOpen property changes to true.
SubmenuOpening	Occurs when a submenu is opening.
Unchecked	Occurs when a C1MenuItem is unchecked.