DataGridViewRowContextMenuStripNeededEventArgs Class

 

Provides data for the RowContextMenuStripNeeded event.

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

System::Object
  System::EventArgs
    System.Windows.Forms::DataGridViewRowContextMenuStripNeededEventArgs

public ref class DataGridViewRowContextMenuStripNeededEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodDataGridViewRowContextMenuStripNeededEventArgs(Int32)

Initializes a new instance of the DataGridViewRowContextMenuStripNeededEventArgs class.

NameDescription
System_CAPS_pubpropertyContextMenuStrip

Gets or sets the shortcut menu for the row that raised the RowContextMenuStripNeeded event.

System_CAPS_pubpropertyRowIndex

Gets the index of the row that is requesting a shortcut menu.

NameDescription
System_CAPS_pubmethodEquals(Object^)

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

System_CAPS_protmethodFinalize()

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

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetType()

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

System_CAPS_protmethodMemberwiseClone()

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

System_CAPS_pubmethodToString()

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

The RowContextMenuStripNeeded event occurs only when the DataGridView control DataSource property is set or its VirtualMode property is true. Handling the 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 RowContextMenuStripNeeded event, the shortcut menu that you specify in the handler is shown whenever the user right-clicks a row unless the CellContextMenuStripNeeded event overrides the shortcut menu for the specific cell that was clicked.

The 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 RowIndex property to determine the state of a row or the values it contains, and use this information to change or modify the ContextMenuStrip property. This property is initialized with the value of the row ContextMenuStrip property, which the event value overrides.

Handle the RowContextMenuStripNeeded event when working with large amounts of data to avoid the performance penalties of setting the row 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 NIB: Consuming Events.

The following code example handles the RowContextMenuStripNeeded event to provide a ContextMenuStrip based on the title of the employee. In this example, there are two shortcut menus, one for managers and one for all other employees.

No code example is currently available or this language may not be supported.

.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
Show: