Class XPMenusProvider

The XPMenusProvider class implements the IContextMenuProvider interface and serves as the menu provider for the Syncfusion Essential Tools XPMenus. Controls that have a XPMenusProvider object set as their menu provider will display a PopupMenu instance. IContextMenuProvider

Inheritance

System.Object

XPMenusProvider

Implements

IContextMenuProvider

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Tools.XPMenus

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class XPMenusProvider : IContextMenuProvider

Constructors

XPMenusProvider()

Creates an instance of the XPMenusProvider class.

Declaration

public XPMenusProvider()

Fields

m_bNeedAddRemoveButton

Declaration

protected bool m_bNeedAddRemoveButton

Field Value

Type
System.Boolean

popupMenu

Declaration

protected PopupMenu popupMenu

Field Value

Type
PopupMenu

textHandlerMap

Declaration

protected Hashtable textHandlerMap

Field Value

Type
System.Collections.Hashtable

Methods

AddContextMenuItem(String, EventHandler)

Overridden. See AddContextMenuItem(String, String, EventHandler).

Declaration

public void AddContextMenuItem(string itemtext, EventHandler handler)

Parameters

Type	Name	Description
System.String	itemtext
System.EventHandler	handler

AddContextMenuItem(String, String, EventHandler)

Overridden. See AddContextMenuItem(String, String, EventHandler).

Declaration

public void AddContextMenuItem(string parentitemtext, string itemtext, EventHandler handler)

Parameters

Type	Name	Description
System.String	parentitemtext
System.String	itemtext
System.EventHandler	handler

Clear()

Clears all menu entries.

Declaration

public void Clear()

ContextMenuCommandHandler(Object, EventArgs)

Declaration

protected void ContextMenuCommandHandler(object sender, EventArgs args)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	args

DisposeContextMenu()

Overridden. See DisposeContextMenu().

Declaration

public void DisposeContextMenu()

GetContextMenuItemChecked(String)

Overridden. See GetContextMenuItemChecked(String).

Declaration

public bool GetContextMenuItemChecked(string itemtext)

Parameters

Type	Name	Description
System.String	itemtext

Returns

Type
System.Boolean

GetContextMenuItemEnabled(String)

Overridden. See GetContextMenuItemEnabled(String).

Declaration

public bool GetContextMenuItemEnabled(string itemtext)

Parameters

Type	Name	Description
System.String	itemtext

Returns

Type
System.Boolean

GetContextMenuItemShortcut(String)

Overridden. See GetContextMenuItemShortcut(String).

Declaration

public Shortcut GetContextMenuItemShortcut(string itemtext)

Parameters

Type	Name	Description
System.String	itemtext

Returns

Type
System.Windows.Forms.Shortcut

GetItemsCount()

Gets the ContextMenu items Count.

Declaration

public int GetItemsCount()

Returns

Type
System.Int32

InitializeContextMenu()

Overridden. See InitializeContextMenu().

Declaration

public void InitializeContextMenu()

NeedAddRemoveButtons()

Indicates whether "Add or Remove buttons" is needed.

Declaration

public bool NeedAddRemoveButtons()

Returns

Type
System.Boolean

RecurseContainsMenuItem(ParentBarItem, String)

Declaration

protected bool RecurseContainsMenuItem(ParentBarItem parentitem, string itemtext)

Parameters

Type	Name	Description
ParentBarItem	parentitem
System.String	itemtext

Returns

Type
System.Boolean

RecurseDisposeMenuItems(ParentBarItem)

Declaration

protected void RecurseDisposeMenuItems(ParentBarItem parentitem)

Parameters

Type	Name	Description
ParentBarItem	parentitem

RecurseGetMenuItem(ParentBarItem, String)

Declaration

protected BarItem RecurseGetMenuItem(ParentBarItem parentitem, string itemtext)

Parameters

Type	Name	Description
ParentBarItem	parentitem
System.String	itemtext

Returns

Type
BarItem

RecurseGetParentMenuItem(ParentBarItem, String)

Declaration

protected ParentBarItem RecurseGetParentMenuItem(ParentBarItem parentitem, string itemtext)

Parameters

Type	Name	Description
ParentBarItem	parentitem
System.String	itemtext

Returns

Type
ParentBarItem

RemoveContextMenuItem(String)

Overridden. See RemoveContextMenuItem(String).

Declaration

public void RemoveContextMenuItem(string itemtext)

Parameters

Type	Name	Description
System.String	itemtext

SetContextMenuItemChecked(String, Boolean)

Overridden. See SetContextMenuItemChecked(String, Boolean).

Declaration

public void SetContextMenuItemChecked(string itemtext, bool bchecked)

Parameters

Type	Name	Description
System.String	itemtext
System.Boolean	bchecked

SetContextMenuItemEnabled(String, Boolean)

Overridden. See SetContextMenuItemEnabled(String, Boolean).

Declaration

public void SetContextMenuItemEnabled(string itemtext, bool benabled)

Parameters

Type	Name	Description
System.String	itemtext
System.Boolean	benabled

SetContextMenuItemImage(String, ImageList, Int32)

Overridden. See SetContextMenuItemImage(String, ImageList, Int32).

Declaration

public void SetContextMenuItemImage(string itemtext, ImageList list, int index)

Parameters

Type	Name	Description
System.String	itemtext
System.Windows.Forms.ImageList	list
System.Int32	index

SetContextMenuItemSeparator(String, Boolean)

Overridden. See SetContextMenuItemSeparator(String, Boolean).

Declaration

public void SetContextMenuItemSeparator(string itemtext, bool binsertseparator)

Parameters

Type	Name	Description
System.String	itemtext
System.Boolean	binsertseparator

SetContextMenuItemShortcut(String, Shortcut)

Overridden. See SetContextMenuItemShortcut(String, Shortcut).

Declaration

public void SetContextMenuItemShortcut(string itemtext, Shortcut key)

Parameters

Type	Name	Description
System.String	itemtext
System.Windows.Forms.Shortcut	key

SetVisualStyle(VisualStyle)

Overridden. See SetVisualStyle(VisualStyle).

Declaration

public void SetVisualStyle(VisualStyle style)

Parameters

Type	Name	Description
VisualStyle	style

ShowContextMenu(Control, Point)

Overridden. See ShowContextMenu(Control, Point).

Declaration

public void ShowContextMenu(Control owner, Point pt)

Parameters

Type	Name	Description
System.Windows.Forms.Control	owner
System.Drawing.Point	pt

Events

Collapse

Occurs when menu is collapsed.

Declaration

public event EventHandler Collapse

Event Type

Type
System.EventHandler

Popup

Occurs when menu is popped up.

Declaration

public event EventHandler Popup

Event Type

Type
System.EventHandler

Implements

IContextMenuProvider