ICancelAddNew Interface

Adds transactional capability when adding a new item to a collection.

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

public interface ICancelAddNew

The ICancelAddNew type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkCancelNewDiscards a pending new item from the collection.
Public methodSupported by the XNA FrameworkEndNewCommits a pending new item to the collection.
Top

The ICancelAddNew interface enables a collection to add a new item in an extensible way. The new item subsequently can be committed or rolled back. The AddNew method of the collection is used to tentatively add the item, which is subsequently transacted through the following operations:

  • The EndNew method will explicitly commit the pending addition.

  • Performing another collection operation, such as an insertion, removal, or move will implicitly commit the pending addition.

  • The CancelNew method will roll back the pending addition if it has not already been committed.

NoteNote

In some scenarios, such as Windows Forms complex data binding, the collection may receive CancelNew or EndNew calls for items other than the newly added item. (Each item is typically a row in a data view.) Ignore these calls; cancel or commit the new item only when that item's index is specified.

There are two models that allow transactional addition of an item to a data-bound collection:

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft