BindingList(Of T).AllowRemove Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets or sets a value indicating whether you can remove items from the collection.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

Public Property AllowRemove As Boolean

Property Value

Type: System.Boolean

true if you can remove items from the list with the RemoveItem method otherwise, false. The default is true.

The AllowRemove property is typically used by other components to determine if the removal of items is allowed.

When AllowRemove is set to a new value, a ListChanged event of type Reset occurs.

The following code example demonstrates how to set the AllowRemove property. For the complete example, see the BindingList(Of T) class overview topic.

' 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

.NET Framework
Available since 2.0
Return to top