Export (0) Print
Expand All

ColumnClickEventArgs Class

Provides data for the ColumnClick event.

System.Object
  System.EventArgs
    System.Windows.Forms.ColumnClickEventArgs

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

'Declaration
Public Class ColumnClickEventArgs _
	Inherits EventArgs

The ColumnClickEventArgs type exposes the following members.

  NameDescription
Public methodColumnClickEventArgsInitializes a new instance of the ColumnClickEventArgs class.
Top

  NameDescription
Public propertyColumnGets the zero-based index of the column that is clicked.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The ColumnClickEventArgs class provides the zero-based index within the ListView.ColumnHeaderCollection class of the column that is clicked in the ListView control. You can use this information in an event handler for the ColumnClick event to determine which column is being clicked to perform tasks on the data within the column.

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the ColumnClick event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type ListView named ListView1. Then ensure that the event handler is associated with the ColumnClick event.


Private Sub ListView1_ColumnClick(sender as Object, e as ColumnClickEventArgs) _ 
     Handles ListView1.ColumnClick

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "Column", e.Column)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"ColumnClick Event")

End Sub


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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

Community Additions

ADD
Show:
© 2014 Microsoft