| layout | post |
|---|---|
| title | Context Menu in Windows Forms Diagram control | Syncfusion® |
| description | Learn about Context Menu support in Syncfusion® Windows Forms Diagram control, its elements, and more details. |
| platform | windowsforms |
| control | Diagram |
| documentation | ug |
The WinForms Diagram provides built-in context menu support to the Diagram.
All available tools for the Diagram control such as File options, Edit options, Action options, Layout, Connectors, and Shapes are listed in the built-in context menu.
Use Case Scenarios
This feature enables easy access of frequently used options.
Properties_
| Property | Description | Type | Data Type | Reference links |
|---|---|---|---|---|
| {{'[DefaultContextMenuEnabled](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.Diagram.DiagramProperties.html#Syncfusion_Windows_Forms_Diagram_DiagramProperties_DefaultContextMenuEnabled)'| markdownify }} | Used to enable default context menu. | NA | Boolean | NA |
Enabling Default Context Menu
You can enable the default context menu using the DefaultContextMenuEnabled property.
The following code illustrates how to enable the default context menu:
{% tabs %} {% highlight c# %}
//show default context menu diagram1.DefaultContextMenuEnabled = true; {% endhighlight %} {% highlight vb %}
'show default context menu diagram1.DefaultContextMenuEnabled = True
{% endhighlight %} {% endtabs %}
The following code illustrates how to disable the default context menu:
{% tabs %} {% highlight c# %}
//hide default context menu diagram1.DefaultContextMenuEnabled = false;
{% endhighlight %} {% highlight vb %}
'hide default context menu diagram1.DefaultContextMenuEnabled = False
{% endhighlight %} {% endtabs %}
Sample Link
To view a sample:
- Open the Syncfusion® Dashboard.
- Click the Windows Forms drop-down list and select Run Locally Installed Samples.
- Navigate to Diagram Samples > Product Showcase > Diagram Builder.
You can conditionally show or hide context menu items at run time. In this, you can make a custom context menu by clearing the default context menu items.The following code example illustrates how to create the context menu item based on diagram elements selection.
The following code example illustrates how to define those.
{% tabs %} {% highlight c# %}
//Used to clear the default contextmenu items diagram1.ContextMenuStrip.Items.Clear();
//To initalize custom menus for diagram context menu items System.Windows.Forms.ToolStripMenuItem fillToolStripMenuItem = new System.Windows.Forms.ToolStripMenuItem(); System.Windows.Forms.ToolStripMenuItem blueToolStripMenuItem = new System.Windows.Forms.ToolStripMenuItem(); System.Windows.Forms.ToolStripMenuItem strokeToolStripMenuItem = new System.Windows.Forms.ToolStripMenuItem(); System.Windows.Forms.ToolStripMenuItem blueToolStripMenuItem1 = new System.Windows.Forms.ToolStripMenuItem();
fillToolStripMenuItem.DropDownItems.AddRange(new System.Windows.Forms.ToolStripItem[] {blueToolStripMenuItem});
//adding properties to the items fillToolStripMenuItem.Name = "fillToolStripMenuItem"; fillToolStripMenuItem.Size = new System.Drawing.Size(210, 24); fillToolStripMenuItem.Text = "Fill"; blueToolStripMenuItem.Name = "blueToolStripMenuItem"; blueToolStripMenuItem.Size = new System.Drawing.Size(121, 26); blueToolStripMenuItem.Text = "Blue"; blueToolStripMenuItem.Click += new System.EventHandler(blueToolStripMenuItem_Click); blueToolStripMenuItem1.Name = "blueToolStripMenuItem1"; blueToolStripMenuItem1.Size = new System.Drawing.Size(121, 26); blueToolStripMenuItem1.Text = "Blue"; blueToolStripMenuItem1.Click += new System.EventHandler(blueToolStripMenuItem1_Click); strokeToolStripMenuItem.DropDownItems.AddRange(new System.Windows.Forms.ToolStripItem[] {blueToolStripMenuItem1}); strokeToolStripMenuItem.Name = "strokeToolStripMenuItem"; strokeToolStripMenuItem.Size = new System.Drawing.Size(210, 24); strokeToolStripMenuItem.Text = "Stroke"; this.diagram1.ContextMenuStrip.Items.AddRange(new System.Windows.Forms.ToolStripItem[] {fillToolStripMenuItem, strokeToolStripMenuItem});
//To register NodeMouseEnter event to diagram controller diagram1.EventSink.NodeMouseEnter += EventSink_NodeMouseEnter;
private void EventSink_NodeMouseEnter(NodeMouseEventArgs evtArgs) { //To show/hide context menu item based on selected objects in diagram if (evtArgs.Node is Node) { diagram1.ContextMenuStrip.Items[0].Visible = true; diagram1.ContextMenuStrip.Items[1].Visible = false; } if (evtArgs.Node is ConnectorBase) { diagram1.ContextMenuStrip.Items[0].Visible = false; diagram1.ContextMenuStrip.Items[1].Visible = true;
}
}
{% endhighlight %} {% endtabs %}