Control.ContextMenu Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the shortcut menu associated with the control.

public:
 virtual property System::Windows::Forms::ContextMenu ^ ContextMenu { System::Windows::Forms::ContextMenu ^ get(); void set(System::Windows::Forms::ContextMenu ^ value); };

public virtual System.Windows.Forms.ContextMenu ContextMenu { get; set; }

[System.ComponentModel.Browsable(false)]
public virtual System.Windows.Forms.ContextMenu ContextMenu { get; set; }

member this.ContextMenu : System.Windows.Forms.ContextMenu with get, set

[<System.ComponentModel.Browsable(false)>]
member this.ContextMenu : System.Windows.Forms.ContextMenu with get, set

Public Overridable Property ContextMenu As ContextMenu

Property Value

ContextMenu

A ContextMenu that represents the shortcut menu associated with the control.

Attributes: BrowsableAttribute

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.

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) );
      }
   }

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) );      
   }
}

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

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.

Applies to

Deila með