BindingList<T>.CancelNew Method

Discards a pending new item.

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

public virtual void CancelNew(
	int itemIndex
)

Parameters

itemIndex
Type: System.Int32

The index of the of the new item to be added

Implements

ICancelAddNew.CancelNew(Int32)

The CancelNew method rolls back a pending new item that was added through the AddNew method, but has not yet been committed.

For more information about adding and committing new items, see the AddNew method

The following code example demonstrates how use the CancelNew method. For the complete example, see the BindingList<T> class overview topic.

// Add the new part unless the part number contains 
// spaces. In that case cancel the add. 
private void button1_Click(object sender, EventArgs e)
{
    Part newPart = listOfParts.AddNew();

    if (newPart.PartName.Contains(" "))
    {
        MessageBox.Show("Part names cannot contain spaces.");
        listOfParts.CancelNew(listOfParts.IndexOf(newPart));
    }
    else
    {
        textBox2.Text = randomNumber.Next(9999).ToString();
        textBox1.Text = "Enter part name";
    }
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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
Show:
© 2014 Microsoft