BindingList(Of T).AllowEdit 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 items in the list can be edited.

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

Public Property AllowEdit As Boolean

Property Value

Type: System.Boolean

true if list items can be edited; otherwise, false. The default is true.

The AllowEdit property is typically used by other components to determine if editing of items in the list is allowed. When AllowEdit is set to a new value, a ListChanged event of type Reset will occur.

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