BindingList<T>.RaiseListChangedEvents Property

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.TypeConverter.dll

Source:

BindingList.cs

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

public:
 property bool RaiseListChangedEvents { bool get(); void set(bool value); };

public bool RaiseListChangedEvents { get; set; }

member this.RaiseListChangedEvents : bool with get, set

Public Property RaiseListChangedEvents As Boolean

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.

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

' Declare a new BindingListOfT with the Part business object.
Private WithEvents listOfParts As BindingList(Of Part)

Private Sub InitializeListOfParts()

    ' Create the new BindingList of Part type.
    listOfParts = New BindingList(Of 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))

End Sub

Remarks

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