ListChangedEventArgs Class
Provides data for the ListChanged event.
Namespace: System.ComponentModel
Assembly: System (in System.dll)
The ListChangedEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
 | ListChangedEventArgs(ListChangedType, PropertyDescriptor) | Initializes a new instance of the ListChangedEventArgs class given the type of change and the PropertyDescriptor affected. |
| ListChangedEventArgs(ListChangedType, Int32) | Initializes a new instance of the ListChangedEventArgs class given the type of change and the index of the affected item. |
| ListChangedEventArgs(ListChangedType, Int32, PropertyDescriptor) | Initializes a new instance of the ListChangedEventArgs class given the type of change, the index of the affected item, and a PropertyDescriptor describing the affected item. |
| ListChangedEventArgs(ListChangedType, Int32, Int32) | Initializes a new instance of the ListChangedEventArgs class given the type of change and the old and new index of the item that was moved. |
| Name | Description | |
|---|---|---|
| ListChangedType | Gets the type of change. |
| NewIndex | Gets the index of the item affected by the change. |
| OldIndex | Gets the old index of an item that has been moved. |
| PropertyDescriptor | Gets the PropertyDescriptor that was added, changed, or deleted. |
| Name | Description | |
|---|---|---|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
A ListChanged event is raised when the data in an IBindingList changes.
The NewIndex property indicates the index of the item that was added, changed, or deleted. If an item was moved, the NewIndex property indicates the new location of the item and the OldIndex property indicates the old location.
If only one item is affected by a change, the OldIndex property value is -1.
| Note |
|---|
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes. |
The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the BindingSource.ListChanged 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 BindingSource named BindingSource1. Then ensure that the event handler is associated with the BindingSource.ListChanged event.
private void BindingSource1_ListChanged(Object sender, ListChangedEventArgs e) { System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder(); messageBoxCS.AppendFormat("{0} = {1}", "ListChangedType", e.ListChangedType ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "NewIndex", e.NewIndex ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "OldIndex", e.OldIndex ); messageBoxCS.AppendLine(); messageBoxCS.AppendFormat("{0} = {1}", "PropertyDescriptor", e.PropertyDescriptor ); messageBoxCS.AppendLine(); MessageBox.Show(messageBoxCS.ToString(), "ListChanged Event" ); }
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.
