BindingList<T>.CancelNew(Int32) Method

Reference

Definition

Namespace:: System.ComponentModel

Assembly:: System.ComponentModel.TypeConverter.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: BindingList.cs

Source:: BindingList.cs

Source:: BindingList.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Discards a pending new item.

public:
 virtual void CancelNew(int itemIndex);

public virtual void CancelNew (int itemIndex);

abstract member CancelNew : int -> unit
override this.CancelNew : int -> unit

Public Overridable Sub CancelNew (itemIndex As Integer)

Parameters

itemIndex: Int32

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

Implements

CancelNew(Int32)

Examples

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";
    }
}

' Add the new part unless the part number contains
' spaces. In that case cancel the add.
Private Sub button1_Click(ByVal sender As Object, _
    ByVal e As EventArgs) Handles button1.Click

    Dim newPart As Part = listOfParts.AddNew()

    If newPart.PartName.Contains(" ") Then
        MessageBox.Show("Part names cannot contain spaces.")
        listOfParts.CancelNew(listOfParts.IndexOf(newPart))
    Else
        textBox2.Text = randomNumber.Next(9999).ToString()
        textBox1.Text = "Enter part name"
    End If

End Sub

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

Del via