Class CustomMenuItem

Represents a custom menu item class.

Inheritance

System.Object

CustomMenuItem

Implements

System.IDisposable

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

[SkinType(SkinVisualStyle = Skin.Office2007Blue, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/Office2007BlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2007Black, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/Office2007BlackStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2007Silver, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/Office2007SilverStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Blue, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/Office2010BlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Black, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/Office2010BlackStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Silver, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/Office2010SilverStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2003, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/Office2003Style.xaml")]
[SkinType(SkinVisualStyle = Skin.Blend, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/BlendStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.SyncOrange, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/SyncOrangeStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.ShinyRed, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/ShinyRedStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.ShinyBlue, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/ShinyBlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Default, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF;component/Framework/DockingManager/Themes/vista.aero.xaml")]
[SkinType(SkinVisualStyle = Skin.VS2010, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/VS2010Style.xaml")]
[SkinType(SkinVisualStyle = Skin.Transparent, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/TransparentStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Metro, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/MetroStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2013, Type = typeof(DockingManager), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Framework/DockingManager/Themes/Office2013Style.xaml")]
public class CustomMenuItem : MenuItem, IDisposable

Constructors

CustomMenuItem()

Initializes a new instance of the CustomMenuItem class.

Declaration

public CustomMenuItem()

Fields

HeaderInIconAreaProperty

Identifies the HeaderInIconAreaProperty dependency property.

Declaration

public static readonly DependencyProperty HeaderInIconAreaProperty

Field Value

Type
System.Windows.DependencyProperty

IconTemplateProperty

Identifies the IconTemplateProperty dependency property.

Declaration

public static DependencyProperty IconTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

IsSeparatorProperty

Declaration

public static readonly DependencyProperty IsSeparatorProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

HeaderInIconArea

Gets or sets a value indicating whether the HeaderInIconArea dependency property.

Declaration

[Obsolete("HeaderInIconArea property is deprecated")]
public bool HeaderInIconArea { get; set; }

Property Value

Type
System.Boolean

Remarks

This property determines what will be shown in the left area of menu item - icon or header. If it set to true - header will be displayed instead of icon, otherwise - icon will be displayed (but only for checked item).

IconTemplate

Gets or sets the value of the IconTemplateProperty dependency property.

Declaration

[Obsolete("IconTemplate Property is deprecated")]
public DataTemplate IconTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

Remarks

This property is used to get / set data template for the icon.

IsSeparator

Gets or sets a value indicating whether the menu item can act as a separator or CustomMenuItem.

Declaration

[Obsolete("This property is deprecated")]
public bool IsSeparator { get; set; }

Property Value

Type
System.Boolean

Methods

Dispose()

To clear unused objects

Declaration

public void Dispose()

OnChecked(RoutedEventArgs)

Called when the MenuItem Checked CustomMenuItem.

Declaration

protected override void OnChecked(RoutedEventArgs e)

Parameters

Type	Name	Description
System.Windows.RoutedEventArgs	e

OnHeaderChanged(Object, Object)

Called when the Header property of a CustomMenuItem changes.

Declaration

protected override void OnHeaderChanged(object oldHeader, object newHeader)

Parameters

Type	Name	Description
System.Object	oldHeader	The old value of the System.Runtime.Remoting.Messaging.Header property.
System.Object	newHeader	The new value of the System.Runtime.Remoting.Messaging.Header property.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Called when IsTouchEnabled property changes

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property changed details

Events

HeaderInIconAreaChanged

Event that is raised when HeaderInIconArea property is changed.

Declaration

public event PropertyChangedCallback HeaderInIconAreaChanged

Event Type

Type
System.Windows.PropertyChangedCallback

Implements

System.IDisposable