ICancelAddNew Interface

Definition

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

public interface class ICancelAddNew
public interface ICancelAddNew
type ICancelAddNew = interface
Public Interface ICancelAddNew
Derived

Remarks

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.

Note

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:

Methods

CancelNew(Int32)

Discards a pending new item from the collection.

EndNew(Int32)

Commits a pending new item to the collection.

Applies to

See also