Provides data for the BindingSource.AddingNew event.
System.EventArgs
System.ComponentModel.AddingNewEventArgs
Namespace: System.ComponentModel
Assembly: System (in System.dll)
<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState := True)> _ Public Class AddingNewEventArgs _ Inherits EventArgs
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)] public class AddingNewEventArgs : EventArgs
[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)] public ref class AddingNewEventArgs : public EventArgs
[<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)>] type AddingNewEventArgs = class inherit EventArgs end
The AddingNewEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
|
AddingNewEventArgs() | Initializes a new instance of the AddingNewEventArgs class using no parameters. |
|
|
AddingNewEventArgs(Object) | Initializes a new instance of the AddingNewEventArgs class using the specified object as the new item. |
| Name | Description | |
|---|---|---|
|
NewObject | Gets or sets the object to be added to the binding list. |
| Name | Description | |
|---|---|---|
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ToString | 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 Consuming Events.
Note
|
|---|
|
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes. |
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. Private Sub customersBindingSource_AddingNew( _ ByVal sender As Object, _ ByVal e As AddingNewEventArgs) _ Handles customersBindingSource.AddingNew e.NewObject = DemoCustomer.CreateNewCustomer() End Sub
// This event handler provides custom item-creation behavior. void customersBindingSource_AddingNew( object sender, AddingNewEventArgs e) { e.NewObject = DemoCustomer.CreateNewCustomer(); }
// This event handler provides custom item-creation behavior. void OnCustomersBindingSourceAddingNew(Object^ sender, AddingNewEventArgs^ e) { e->NewObject = DemoCustomer::CreateNewCustomer(); }
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.