Export (0) Print
Expand All
Expand Minimize

DataGridView.OnColumnHeaderMouseClick Method

Raises the ColumnHeaderMouseClick event.

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

protected virtual void OnColumnHeaderMouseClick(
	DataGridViewCellMouseEventArgs e
)

ExceptionCondition
ArgumentOutOfRangeException

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

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

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 in a derived class, be sure to call the base class's OnColumnHeaderMouseClick method so that registered delegates receive the event.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft