This topic has not yet been rated - Rate this topic

ListChangedEventArgs Class

Provides data for the ListChanged event.

System.Object
  System.EventArgs
    System.ComponentModel.ListChangedEventArgs

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class ListChangedEventArgs : EventArgs

The ListChangedEventArgs type exposes the following members.

  Name Description
Public method Supported by the XNA Framework ListChangedEventArgs(ListChangedType, PropertyDescriptor) Initializes a new instance of the ListChangedEventArgs class given the type of change and the PropertyDescriptor affected.
Public method Supported by the XNA Framework ListChangedEventArgs(ListChangedType, Int32) Initializes a new instance of the ListChangedEventArgs class given the type of change and the index of the affected item.
Public method Supported by the XNA Framework 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.
Public method Supported by the XNA Framework 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.
Top
  Name Description
Public property Supported by the XNA Framework ListChangedType Gets the type of change.
Public property Supported by the XNA Framework NewIndex Gets the index of the item affected by the change.
Public property Supported by the XNA Framework OldIndex Gets the old index of an item that has been moved.
Public property PropertyDescriptor Gets the PropertyDescriptor that was added, changed, or deleted.
Top
  Name Description
Public method Supported by the XNA Framework Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by the XNA Framework Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method Supported by the XNA Framework GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Supported by the XNA Framework MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework ToString Returns a string that represents the current object. (Inherited from Object.)
Top

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 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" );
}


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ