This documentation is archived and is not being maintained.

BindingList<T>.AllowNew Property

Gets or sets a value indicating whether you can add items to the list using the AddNew method.

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

public bool AllowNew { get; set; }

Property Value

Type: System.Boolean
true if you can add items to the list with the AddNew method; otherwise, false. The default depends on the underlying type contained in the list.

The AllowNew property is typically used by other components to determine if the creation of new items is allowed. AllowNew defaults to true if the type contained in the list has a default constructor or the AddingNew event is handled. If the AddingNew event is not handled or the list type does not have a default constructor, then AllowNew defaults to false.

If AllowNew is explicitly set, the set value will always be used by bound objects to determine if new items can be added to the list. Whether AllowNew is true or false, new items can be added by explicitly calling AddNew if the list type has a default constructor or the AddingNew event is handled. In addition, setting AllowNew causes a ListChanged event of type Reset to occur.

The following code example demonstrates how to set the AllowNew 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));
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: