ListView.ColumnWidthChanging Event

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

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 width of a column is changing.

public:
 event System::Windows::Forms::ColumnWidthChangingEventHandler ^ ColumnWidthChanging;

public event System.Windows.Forms.ColumnWidthChangingEventHandler ColumnWidthChanging;

public event System.Windows.Forms.ColumnWidthChangingEventHandler? ColumnWidthChanging;

member this.ColumnWidthChanging : System.Windows.Forms.ColumnWidthChangingEventHandler

Public Custom Event ColumnWidthChanging As ColumnWidthChangingEventHandler

Event Type

ColumnWidthChangingEventHandler

Examples

The following code example demonstrates handling the ColumnWidthChanging event. It also demonstrates the ColumnWidthChangingEventArgs.NewWidth and Cancel members. To run this example, paste the code into a Windows Form. Call InitializeListView1 from the form's constructor or Load event handler.

 ListView listView1 = new ListView();
 private void InitializeListView1()
 {
     // Initialize a ListView in detail view and add some columns.
     listView1.View = View.Details;
     listView1.Width = 200;
     listView1.Columns.Add("Column1");
     listView1.Columns.Add("Column2");

     // Associate a method with the ColumnWidthChangingEvent.
     listView1.ColumnWidthChanging += 
         new ColumnWidthChangingEventHandler(listView1_ColumnWidthChanging);
     this.Controls.Add(listView1);
 }

 // Handle the ColumnWidthChangingEvent.
 private void listView1_ColumnWidthChanging(object sender,  
     ColumnWidthChangingEventArgs e)
 {
     // Check if the new width is too big or too small.
     if (e.NewWidth > 100 || e.NewWidth < 5)
     {
         // Cancel the event and inform the user if the new
         // width does not meet the criteria.
         MessageBox.Show("Column width is too large or too small");
         e.Cancel = true;
     }
 }

Private WithEvents listView1 As New ListView()

Private Sub InitializeListView1()

    ' Initialize a ListView in detail view and add some columns.
    listView1.View = View.Details
    listView1.Width = 200
    listView1.Columns.Add("Column1")
    listView1.Columns.Add("Column2")
    Me.Controls.Add(listView1)

End Sub


' Handle the ColumnWidthChangingEvent.
Private Sub listView1_ColumnWidthChanging(ByVal sender As Object, _
    ByVal e As ColumnWidthChangingEventArgs) _
    Handles listView1.ColumnWidthChanging

    ' Check if the new width is too big or too small.
    If e.NewWidth > 100 OrElse e.NewWidth < 5 Then

        ' Cancel the event and inform the user if the new
        ' width does not meet the criteria.
        MessageBox.Show("Column width is too large or too small")
        e.Cancel = True
    End If

End Sub

Remarks

This event allows you to check the new column width with the ColumnWidthChangingEventArgs.NewWidth property, and cancel the event if you choose by setting the Cancel property to true.

For more information about handling events, see Handling and Raising Events.

Applies to

Share via