BindingList<T>.CancelNew(Int32) Method

Definition

Discards a pending new item.

C#
public virtual void CancelNew(int itemIndex);

Parameters

itemIndex
Int32

The index of the of the new item to be added.

Implements

Examples

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

C#
// 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";
    }
}

Remarks

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

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

See also