System.Windows.Forms.DataGridViewCellContextMenuStripNeededEventHandler Delegate

Represents the method that will handle a DataGridView.CellContextMenuStripNeeded event of a System.Windows.Forms.DataGridView.

Syntax

public delegate void DataGridViewCellContextMenuStripNeededEventHandler (object sender, DataGridViewCellContextMenuStripNeededEventArgs e)

Parameters

sender
Documentation for this section has not yet been entered.
e
Documentation for this section has not yet been entered.

Remarks

The DataGridView.CellContextMenuStripNeeded event occurs only when the System.Windows.Forms.DataGridView control DataGridView.DataSource property is set or its DataGridView.VirtualMode property is true.

When you handle the DataGridView.CellContextMenuStripNeeded event, the shortcut menu that you specify in the handler is shown whenever the user right-clicks a cell. This is useful when you want to display shortcut menus determined by the current state or value of a cell.

The DataGridView.CellContextMenuStripNeeded event also occurs whenever the value of the DataGridViewCell.ContextMenuStrip property is retrieved, either programmatically or when the user right-clicks the cell.

You can use the DataGridViewCellEventArgs.ColumnIndex and DataGridViewCellEventArgs.RowIndex properties to determine the state or value of a cell, and use this information to set the DataGridViewCellContextMenuStripNeededEventArgs.ContextMenuStrip property. This property is initialized with the value of the cell DataGridViewCell.ContextMenuStrip property, which the event value overrides.

Handle the DataGridView.CellContextMenuStripNeeded event when working with large amounts of data to avoid the performance penalties of setting the cell DataGridViewCell.ContextMenuStrip value for multiple cells. For more information, see Best Practices for Scaling the Windows Forms DataGridView Control.

You can also specify shortcut menus for individual rows rather than individual cells by setting the row DataGridViewRow.ContextMenuStrip property or handling the System.Windows.Forms.DataGridView control's DataGridView.RowContextMenuStripNeeded event. The cell DataGridViewCell.ContextMenuStrip property setting overrides the row DataGridViewRow.ContextMenuStrip property setting, and the DataGridView.CellContextMenuStripNeeded event overrides both the DataGridView.RowContextMenuStripNeeded event and the row DataGridViewRow.ContextMenuStrip property setting. You can specify null for a cell shortcut menu, however, to prevent a row shortcut menu from being overridden.

For more information about handling events, see Consuming Events.

When you create a System.Windows.Forms.DataGridViewCellContextMenuStripNeededEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see Events and Delegates.

Requirements

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0