ListView.ColumnReordered Event
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Occurs when the column header order is changed.
public:
event System::Windows::Forms::ColumnReorderedEventHandler ^ ColumnReordered;public event System.Windows.Forms.ColumnReorderedEventHandler ColumnReordered;public event System.Windows.Forms.ColumnReorderedEventHandler? ColumnReordered;member this.ColumnReordered : System.Windows.Forms.ColumnReorderedEventHandler Public Custom Event ColumnReordered As ColumnReorderedEventHandler Event Type
Examples
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the ColumnReordered 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 MessageBox.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 ColumnReordered event.
private void ListView1_ColumnReordered(Object sender, ColumnReorderedEventArgs e) {
System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "OldDisplayIndex", e.OldDisplayIndex );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "NewDisplayIndex", e.NewDisplayIndex );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Header", e.Header );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Cancel", e.Cancel );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "ColumnReordered Event" );
}
Private Sub ListView1_ColumnReordered(sender as Object, e as ColumnReorderedEventArgs) _
Handles ListView1.ColumnReordered
Dim messageBoxVB as New System.Text.StringBuilder()
messageBoxVB.AppendFormat("{0} = {1}", "OldDisplayIndex", e.OldDisplayIndex)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "NewDisplayIndex", e.NewDisplayIndex)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "Header", e.Header)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "Cancel", e.Cancel)
messageBoxVB.AppendLine()
MessageBox.Show(messageBoxVB.ToString(),"ColumnReordered Event")
End Sub
Remarks
The ColumnReordered event is a cancelable event and can be canceled by handling the event and setting the Cancel property to true. However, if the event is canceled, the NewDisplayIndex of the ColumnReorderedEventArgs will not change to the OldDisplayIndex value.
For more information about handling events, see Handling and Raising Events.
