BindingList<T>.RaiseListChangedEvents Property

Definition

Namespace:

System.ComponentModel

Assemblies:

netstandard.dll, System.ComponentModel.TypeConverter.dll

Source:

BindingList.cs

Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events.

C#

public bool RaiseListChangedEvents { get; set; }

Property Value

Boolean

true if adding or removing items raises ListChanged events; otherwise, false. The default is true.

Examples

The following code example demonstrates how use the RaiseListChangedEvents method. For the complete example, see the BindingList<T> class overview topic.

C#

    // Declare a new BindingListOfT with the Part business object.
    BindingList<Part> listOfParts; 
    private void InitializeListOfParts()
    {
        // Create the new BindingList of Part type.
        listOfParts = new BindingList<Part>();

        // Allow new parts to be added, but not removed once committed.        
        listOfParts.AllowNew = true;
        listOfParts.AllowRemove = false;

        // Raise ListChanged events when new parts are added.
        listOfParts.RaiseListChangedEvents = true;

        // Do not allow parts to be edited.
        listOfParts.AllowEdit = false;
        
        // Add a couple of parts to the list.
        listOfParts.Add(new Part("Widget", 1234));
        listOfParts.Add(new Part("Gadget", 5647));
    }

Remarks

Set the RaiseListChangedEvents property to false if you wish to suppress ListChanged events from occurring on the list.

Applies to