Control Properties


.NET Framework Class Library
Control..::.ContextMenu Property

Gets or sets the shortcut menu associated with the control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
Syntax

Visual Basic (Declaration)
<BrowsableAttribute(False)> _
Public Overridable Property ContextMenu As ContextMenu
Visual Basic (Usage)
Dim instance As Control
Dim value As ContextMenu

value = instance.ContextMenu

instance.ContextMenu = value
C#
[BrowsableAttribute(false)]
public virtual ContextMenu ContextMenu { get; set; }
Visual C++
[BrowsableAttribute(false)]
public:
virtual property ContextMenu^ ContextMenu {
    ContextMenu^ get ();
    void set (ContextMenu^ value);
}
JScript
public function get ContextMenu () : ContextMenu
public function set ContextMenu (value : ContextMenu)

Property Value

Type: System.Windows.Forms..::.ContextMenu
A ContextMenu that represents the shortcut menu associated with the control.
Remarks

Use a shortcut menus to give context-specific menu options to users when they right-click on the control.

Notes to Inheritors:

When overriding the ContextMenu property in a derived class, use the base class's ContextMenu property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the get and set accessors of the ContextMenu property; you can override only one if needed.

Examples

The following code example displays the ContextMenu assigned to a TreeView when the right mouse button is clicked and released. This code requires that you have a Form with a TreeView on it. It is also required that the TreeView has a ContextMenu assigned to its ContextMenu property.

Visual Basic
Private Sub treeView1_MouseUp(sender As Object, _
  e As MouseEventArgs) Handles treeView1.MouseUp
   ' If the right mouse button was clicked and released,
   ' display the shortcut menu assigned to the TreeView. 
   If e.Button = MouseButtons.Right Then
      treeView1.ContextMenu.Show(treeView1, New Point(e.X, e.Y))
   End If
End Sub
C#
private void treeView1_MouseUp(object sender, MouseEventArgs e)
{
   // If the right mouse button was clicked and released,
   // display the shortcut menu assigned to the TreeView. 
   if(e.Button == MouseButtons.Right)
   {
      treeView1.ContextMenu.Show(treeView1, new Point(e.X, e.Y) );      
   }
}
Visual C++
private:
   void treeView1_MouseUp( Object^ /*sender*/, MouseEventArgs^ e )
   {
      // If the right mouse button was clicked and released,
      // display the shortcut menu assigned to the TreeView.
      if ( e->Button == ::MouseButtons::Right )
      {
         treeView1->ContextMenu->Show( treeView1, Point(e->X,e->Y) );
      }
   }
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
See Also

Reference

Tags :


Page view tracker