DataGridView.OnColumnHeaderMouseClick(DataGridViewCellMouseEventArgs) Method

Definition

Raises the ColumnHeaderMouseClick event.

C#
protected virtual void OnColumnHeaderMouseClick(System.Windows.Forms.DataGridViewCellMouseEventArgs e);

Parameters

Exceptions

The value of the ColumnIndex property of e is less than zero or greater than the number of columns in the control minus one.

Remarks

Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

The OnColumnHeaderMouseClick method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding OnColumnHeaderMouseClick(DataGridViewCellMouseEventArgs) in a derived class, be sure to call the base class's OnColumnHeaderMouseClick(DataGridViewCellMouseEventArgs) method so that registered delegates receive the event.

Applies to

Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

See also