ListViewInsertedEventArgs.AffectedRows Property

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.Extensions.dll

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.

Gets the number of rows affected by the insert operation.

public:
 property int AffectedRows { int get(); };

public int AffectedRows { get; }

member this.AffectedRows : int

Public ReadOnly Property AffectedRows As Integer

Property Value

Int32

The number of rows affected by the insert operation.

Examples

The following example shows how to use the ListViewInsertedEventArgs object that is passed to a handler for the ItemInserted event to determine whether an exception was raised during the insert operation. This code example is part of a larger example provided for the ListViewInsertedEventArgs class.

void ContactsListView_ItemInserted(Object sender, ListViewInsertedEventArgs e)
{
  if (e.Exception != null)
  {
    if (e.AffectedRows == 0)
    {
      e.KeepInInsertMode = true;
      Message.Text = "An exception occurred inserting the new Contact. " +
        "Please verify your values and try again.";
    }
    else
      Message.Text = "An exception occurred inserting the new Contact. " +
        "Please verify the values in the newly inserted item.";

    e.ExceptionHandled = true;
  }
}

Sub ContactsListView_ItemInserted(ByVal sender As Object, ByVal e As ListViewInsertedEventArgs)

  If e.Exception IsNot Nothing Then

    If e.AffectedRows = 0 Then
      e.KeepInInsertMode = True
      Message.Text = "An exception occurred inserting the new Contact. " & _
        "Please verify your values and try again."
    Else
      Message.Text = "An exception occurred inserting the new Contact. " & _
        "Please verify the values in the newly inserted item."
    End If

    e.ExceptionHandled = True
  End If
End Sub

Remarks

Use the AffectedRows property to determine the number of records that were affected by the insert operation, as returned by the data source control. This property is typically used in the following scenarios:

To verify that only a single record was inserted. Sometimes an incorrectly written insert statement can insert multiple records.
To verify that a record was not inserted because an error occurred during the insert operation, but an exception was not raised.
To verify that a record was inserted when a data source control that supports conflict detection (optimistic concurrency) has its ConflictDetection property set to the ConflictOptions.CompareAllValues enumeration value. Controls that supports this property include the SqlDataSource and ObjectDataSource controls. When the property has this value, a record might not be inserted if it has the same key value as a record inserted by another user.

Applies to

Share via