System.Windows.Forms.DataGridViewRowContextMenuStripNeededEventHandler Delegate

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

Syntax

public delegate void DataGridViewRowContextMenuStripNeededEventHandler (object sender, DataGridViewRowContextMenuStripNeededEventArgs 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.RowContextMenuStripNeeded event occurs only when the System.Windows.Forms.DataGridView control DataGridView.DataSource property is set or its DataGridView.VirtualMode property is true. Handling the DataGridView.RowContextMenuStripNeeded event is useful when you want to display a shortcut menu determined by a row's current state or the values it contains.

When you handle the DataGridView.RowContextMenuStripNeeded event, the shortcut menu that you specify in the handler is shown whenever the user right-clicks a row unless the DataGridView.CellContextMenuStripNeeded overrides the shortcut menu for the specific cell that was clicked.

The DataGridView.RowContextMenuStripNeeded event also occurs whenever the value of the DataGridViewRow.ContextMenuStrip property is retrieved, either programmatically or when the user right-clicks a row.

You can use the DataGridViewRowContextMenuStripNeededEventArgs.RowIndex property to determine the state of a row or the values it contains, and use this information to change or modify the DataGridViewRowContextMenuStripNeededEventArgs.ContextMenuStrip property. This property is initialized with the value of the row DataGridViewRow.ContextMenuStrip property, which the event value overrides.

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

For more information about handling events, see Consuming Events.

When you create a System.Windows.Forms.DataGridViewRowContextMenuStripNeededEventHandler 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