ItemCheckEventArgs Class

Provides data for the ItemCheck event of the CheckedListBox and ListView controls.

System.Object
  System.EventArgs
    System.Windows.Forms.ItemCheckEventArgs

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

[ComVisibleAttribute(true)]
public class ItemCheckEventArgs : EventArgs

The ItemCheckEventArgs type exposes the following members.

  NameDescription
Public methodItemCheckEventArgsInitializes a new instance of the ItemCheckEventArgs class.
Top

  NameDescription
Public propertyCurrentValueGets a value indicating the current state of the item's check box.
Public propertyIndexGets the zero-based index of the item to change.
Public propertyNewValueGets or sets a value indicating whether to set the check box for the item to be checked, unchecked, or indeterminate.
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 the default hash function. (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 ItemCheck event occurs when the checked state of an item in a checked list box changes. The ItemCheckEventArgs class specifies the index of the item to change, the current value of the check box for the item, and the new value to set for the check box.

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

The following code example demonstrates a checked ListView control that handles the ListView.ItemCheck event. The method uses the CurrentValue and Index properties of the ItemCheckEventArgs object to retrieve and tally the price of the menu items selected. To run this example paste the following code in 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 all events are associated with their event-handling methods.

	private void InitializeListView()
	{
		this.ListView1 = new System.Windows.Forms.ListView();

		// Set properties such as BackColor and DockStyle and Location. 
		this.ListView1.BackColor = System.Drawing.SystemColors.Control;
		this.ListView1.Dock = System.Windows.Forms.DockStyle.Top;
		this.ListView1.Location = new System.Drawing.Point(0, 0);
		this.ListView1.Size = new System.Drawing.Size(292, 130);
		this.ListView1.View = System.Windows.Forms.View.Details;
		this.ListView1.HideSelection = false;

		// Allow the user to select multiple items. 
		this.ListView1.MultiSelect = true;

		// Show CheckBoxes in the ListView. 
		this.ListView1.CheckBoxes = true;
		
		//Set the column headers and populate the columns.
		ListView1.HeaderStyle = ColumnHeaderStyle.Nonclickable;
		
		ColumnHeader columnHeader1 = new ColumnHeader();
		columnHeader1.Text = "Breakfast Choices";
		columnHeader1.TextAlign = HorizontalAlignment.Left;
		columnHeader1.Width = 146;

		ColumnHeader columnHeader2 = new ColumnHeader();
		columnHeader2.Text = "Price Each";
		columnHeader2.TextAlign = HorizontalAlignment.Center;
		columnHeader2.Width = 142;

       	this.ListView1.Columns.Add(columnHeader1);
		this.ListView1.Columns.Add(columnHeader2);

		string[] foodList = new string[]{"Juice", "Coffee", 
			"Cereal & Milk", "Fruit Plate", "Toast & Jelly", 
			"Bagel & Cream Cheese"};

		string[] foodPrice = new string[]{"1.09", "1.09", "2.19", 
			"2.79", "2.09", "2.69"};
		
		int count;

		// 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.
		ListView1.BeginUpdate();

		for(count = 0; count < foodList.Length; count++)
		{
			ListViewItem listItem = new ListViewItem(foodList[count]);
			listItem.SubItems.Add(foodPrice[count]);
			ListView1.Items.Add(listItem);
		}

		//Call EndUpdate when you finish adding items to the ListView.
		ListView1.EndUpdate();
		this.Controls.Add(this.ListView1);
	}


...


	double price = 0.0;

	// Handles the ItemCheck event. The method uses the CurrentValue 
	// property of the ItemCheckEventArgs to retrieve and tally the   
	// price of the menu items selected.   
	private void ListView1_ItemCheck1(object sender, 
		System.Windows.Forms.ItemCheckEventArgs e)
	{
		if (e.CurrentValue==CheckState.Unchecked)
		{
			price += Double.Parse(
				this.ListView1.Items[e.Index].SubItems[1].Text);
		}
		else if((e.CurrentValue==CheckState.Checked))
		{
			price -= Double.Parse(
				this.ListView1.Items[e.Index].SubItems[1].Text);
		}

		// Output the price to TextBox1.
		TextBox1.Text = price.ToString();
	}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft