BindingList<T>.AllowRemove Property

Definition

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

C#
public bool AllowRemove { get; set; }

Property Value

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

Examples

The following code example demonstrates how to set the AllowRemove property. 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

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.

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

See also