Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
LinqDataSourceStatusEventArgs Class
Collapse the table of content
Expand the table of content

LinqDataSourceStatusEventArgs Class

Provides data for the ContextCreated, Deleted, Inserted, Selected, and Updated events.


Namespace:  System.Web.UI.WebControls
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

Public Class LinqDataSourceStatusEventArgs _
	Inherits EventArgs

The LinqDataSourceStatusEventArgs type exposes the following members.

Public methodLinqDataSourceStatusEventArgs(Exception)Initializes a new instance of the LinqDataSourceStatusEventArgs class by using an exception that occurred as a result of the data operation.
Public methodLinqDataSourceStatusEventArgs(Object)Initializes a new instance of the LinqDataSourceStatusEventArgs class by using an object that contains the data from the data operation.
Public methodLinqDataSourceStatusEventArgs(Object, Int32)Initializes a new instance of the LinqDataSourceStatusEventArgs class with an object that contains the data from the data operation and the number of rows returned.

Public propertyExceptionGets the exception that was thrown during the data operation.
Public propertyExceptionHandledGets or sets a value that indicates whether the exception was handled and that it should not be thrown again.
Public propertyResultGets the object that represents the result of a data operation.
Public propertyTotalRowCountGets the total number of rows in a data set from a data-retrieval operation.

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The LinqDataSourceStatusEventArgs class enables you to examine the results of data operations that have been performed by a LinqDataSource control. A LinqDataSourceStatusEventArgs object is passed to event handlers for the ContextCreated, Deleted, Inserted, Selected, and Updated events of the LinqDataSource control.

If the data operation completed successfully, the resulting data object is stored in the Result property and the Exception property is Nothing. If the data operation failed, the exception that occurred during the data operation is stored in the Exception property and the Result property is Nothing. If you handled the exception represented by the Exception property, set the ExceptionHandled property to true so that the exception will not be thrown.

You retrieve the total number of data records returned from a query through the TotalRowCount property.

The following example shows an event handler for the Inserted event. In the event handler, if the Exception property is Nothing, the product ID is retrieved from the object in the Result property. The product ID is a primary key for the table and is set by the database, therefore the value is not known until the insert operation has finished. The exception message is logged if the Exception property is not equal to Nothing. The ExceptionHandled property is then set to true.

Protected Sub LinqDataSource_Inserted(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.LinqDataSourceStatusEventArgs)
    If (IsNothing(e.Exception)) Then
        Dim newProduct As Product
        newProduct = CType(e.Result, Product)
        Literal1.Text = "The new product id is " & newProduct.ProductID
        Literal1.Visible = True
        Literal1.Text = "We are sorry. There was a problem saving the record. The administrator has been notified."
        Literal1.Visible = True
        e.ExceptionHandled = True
    End If
End Sub

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft