This documentation is archived and is not being maintained.

ListView.ItemCheck Event

Occurs when the check state of an item changes.

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

Public Event ItemCheck As ItemCheckEventHandler
Dim instance As ListView 
Dim handler As ItemCheckEventHandler 

AddHandler instance.ItemCheck, handler

The CheckBoxes property must be set to true in order for check boxes to be displayed next to each item in the ListView control. The ItemCheck event occurs when the check state of an item changes or when the CheckBoxes property is set to true. You can create an event handler for the ItemCheck event to perform tasks such as changing the state of an item's icon or another application-specific task each time an item is checked in the ListView control.


If the Visible property of the ListView control is set to false at the time the control is created, the ItemCheck event is not raised. Once the control is visible, the event is raised regardless of the state of the Visible property.

For more information about handling events, see Consuming Events.

The following code example demonstrates a checked ListView control that handles the ItemCheck event. The method uses the ItemCheckEventArgs.CurrentValue and ItemCheckEventArgs.Index properties to retrieve and tally the price of the menu items selected. To run this example, paste the following code into a form containing a ListView named ListView1 and a TextBox named Textbox1. Call the InititalizeListView method from the form's constructor or Load method. Ensure that the ItemCheck event is associated with the event handler in this example.

Private Sub InitializeListView()
    Me.ListView1 = New System.Windows.Forms.ListView

    ' Set properties such as BackColor, Location and Size
    Me.ListView1.BackColor = System.Drawing.SystemColors.Control
    Me.ListView1.Dock = System.Windows.Forms.DockStyle.Top
    Me.ListView1.Location = New System.Drawing.Point(0, 0)
    Me.ListView1.Size = New System.Drawing.Size(292, 130)
    Me.ListView1.View = System.Windows.Forms.View.Details
    Me.ListView1.HideSelection = False

    ' Allow user to select multiple items.
    Me.ListView1.MultiSelect = True

    ' Show check boxes in the ListView.
    Me.ListView1.CheckBoxes = True

    'Set the column headers and populate the columns.
    ListView1.HeaderStyle = ColumnHeaderStyle.Nonclickable
    Dim columnHeader1 As New ColumnHeader
    With columnHeader1
        .Text = "Breakfast Choices"
        .TextAlign = HorizontalAlignment.Left
        .Width = 146
    End With
    Dim columnHeader2 As New ColumnHeader
    With columnHeader2
        .Text = "Price Each"
        .TextAlign = HorizontalAlignment.Center
        .Width = 142
    End With
    Dim foodList() As String = New String() {"Juice", "Coffee", _
        "Cereal & Milk", "Fruit Plate", "Toast & Jelly", _
        "Bagel & Cream Cheese"}

    Dim foodPrice() As String = New String() {"1.09", "1.09", "2.19", _
        "2.79", "2.09", "2.69"}
    Dim count As Integer

    ' Members are added one at a time, so call BeginUpdate to ensure 
    ' the list is painted only once, rather than as each list item is added.

    For count = 0 To foodList.Length - 1
        Dim listItem As New ListViewItem(foodList(count))

    'Call EndUpdate when you finish adding items to the ListView.
End Sub


Dim price As Double = 0.0

' Handles the ItemChecked event. The method uses the CurrentValue property 
' of the ItemCheckEventArgs to retrieve and tally the price of the menu 
' items selected.  
Private Sub ListView1_ItemCheck1(ByVal sender As Object, _
    ByVal e As System.Windows.Forms.ItemCheckEventArgs) _
    Handles ListView1.ItemCheck

    If (e.CurrentValue = CheckState.Unchecked) Then
        price += Double.Parse( _
    ElseIf (e.CurrentValue = CheckState.Checked) Then
        price -= Double.Parse( _
    End If

    ' Output the price to TextBox1.
    TextBox1.Text = CType(price, String)

End Sub

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0