DataGridViewCellContextMenuStripNeededEventArgs Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Provides data for the CellContextMenuStripNeeded event.

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


public ref class DataGridViewCellContextMenuStripNeededEventArgs : DataGridViewCellEventArgs

System_CAPS_pubmethodDataGridViewCellContextMenuStripNeededEventArgs(Int32, Int32)

Initializes a new instance of the DataGridViewCellContextMenuStripNeededEventArgs class.


Gets a value indicating the column index of the cell that the event occurs for.(Inherited from DataGridViewCellEventArgs.)


Gets or sets the shortcut menu for the cell that raised the CellContextMenuStripNeeded event.


Gets a value indicating the row index of the cell that the event occurs for.(Inherited from DataGridViewCellEventArgs.)


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

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

When you handle the 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 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 ColumnIndex and RowIndex properties to determine the state or value of a cell, and use this information to set the ContextMenuStrip property. This property is initialized with the value of the cell ContextMenuStrip property, which the event value overrides.

Handle the CellContextMenuStripNeeded event when working with large amounts of data to avoid the performance penalties of setting the cell 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 ContextMenuStrip property or handling the DataGridView control's RowContextMenuStripNeeded event. The cell ContextMenuStrip property setting overrides the row ContextMenuStrip property setting, and the CellContextMenuStripNeeded event overrides both the RowContextMenuStripNeeded event and the row 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 NIB: Consuming Events.

The following code example uses the DataGridViewCellContextMenuStripNeededEventArgs class to set the shortcut menu without unsharing the row.

ToolStripMenuItem^ wholeTable;
ToolStripMenuItem^ lookUp;
System::Windows::Forms::ContextMenuStrip^ strip;
String^ cellErrorText;

void dataGridView1_CellContextMenuStripNeeded( Object^ /*sender*/,
    DataGridViewCellContextMenuStripNeededEventArgs^ e )
    cellErrorText = String::Empty;
    if ( strip == nullptr )
        strip = gcnew System::Windows::Forms::ContextMenuStrip;
        lookUp->Text = L"Look Up";
        wholeTable->Text = L"See Whole Table";
        strip->Items->Add( lookUp );
        strip->Items->Add( wholeTable );

    e->ContextMenuStrip = strip;

void wholeTable_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
    dataGridView1->DataSource = Populate( L"Select * from employees", true );

DataGridViewCellEventArgs^ theCellImHoveringOver;
void dataGridView1_CellMouseEnter( Object^ /*sender*/, DataGridViewCellEventArgs^ e )
    theCellImHoveringOver = e;

DataGridViewCellEventArgs^ cellErrorLocation;
void lookUp_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
        dataGridView1->DataSource = Populate( String::Format( L"Select * from employees where {0} = '{1}'", dataGridView1->Columns[ theCellImHoveringOver->ColumnIndex ]->Name, dataGridView1->Rows[ theCellImHoveringOver->RowIndex ]->Cells[ theCellImHoveringOver->ColumnIndex ]->Value ), true );
    catch ( ... ) 
        cellErrorText = L"Can't look this cell up";
        cellErrorLocation = theCellImHoveringOver;


void dataGridView1_CellErrorTextNeeded( Object^ /*sender*/, DataGridViewCellErrorTextNeededEventArgs^ e )
    if ( cellErrorLocation != nullptr )
        if ( e->ColumnIndex == cellErrorLocation->ColumnIndex && e->RowIndex == cellErrorLocation->RowIndex )
            e->ErrorText = cellErrorText;

DataTable^ Populate( String^ query, bool resetUnsharedCounter )
    if ( resetUnsharedCounter )

    // Alter the data source as necessary
    SqlDataAdapter^ adapter = gcnew SqlDataAdapter( query,
        gcnew SqlConnection( L"Integrated Security=SSPI;Persist Security Info=False;"
        L"Initial Catalog=Northwind;Data Source= localhost" ) );
    DataTable^ table = gcnew DataTable;
    adapter->Fill( table );
    return table;

Label^ count;
int unsharedRowCounter;
void ResetCounter()
    unsharedRowCounter = 0;
    count->Text = unsharedRowCounter.ToString();

.NET Framework
Available since 2.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top