AddingNewEventArgs Class
Collapse the table of content
Expand the table of content

AddingNewEventArgs Class


Provides data for the BindingSource.AddingNew event.

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


[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class AddingNewEventArgs : EventArgs


Initializes a new instance of the AddingNewEventArgs class using no parameters.


Initializes a new instance of the AddingNewEventArgs class using the specified object as the new item.


Gets or sets the object to be added to the binding list.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

The AddingNewEventArgs class provides data for the BindingSource.AddingNew event, which signals that an item is about to be added to a collection. The event gives the programmer, within the event handler AddingNewEventHandler, the option of supplying the new object by setting the NewObject property to this new item. If this property is not set, the collection will typically use the default constructor of the appropriate type to construct a new item. In either case, the new item will be added to the collection.

If the collection also implements the ICancelAddNew interface, the item will be provisionally added, waiting a subsequent commit or rollback.

This event is commonly used in data-binding scenarios, within classes such as System.Windows.Forms.BindingSource and System.ComponentModel.BindingList<T>.

For more information about handling events, see NIB: Consuming Events.

The following code example demonstrates how to use the AddingNewEventArgs class to handle the BindingSource.AddingNew event. This code example is part of a larger example provided in How to: Customize Item Addition with the Windows Forms BindingSource.

// This event handler provides custom item-creation behavior.
void customersBindingSource_AddingNew(
    object sender, 
    AddingNewEventArgs e)
    e.NewObject = DemoCustomer.CreateNewCustomer();

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft