BindingList<T>.AllowEdit Property

Reference

Definition

Namespace:: System.ComponentModel

Assembly:: System.ComponentModel.TypeConverter.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: BindingList.cs

Source:: BindingList.cs

Source:: BindingList.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value indicating whether items in the list can be edited.

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

public bool AllowEdit { get; set; }

member this.AllowEdit : bool with get, set

Public Property AllowEdit As Boolean

Property Value

Boolean

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

Examples

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

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.

Applies to

Deila með