SqlDataSourceView Class

Supports the SqlDataSource control and provides an interface for data-bound controls to perform SQL data operations against relational databases.

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

public class SqlDataSourceView : DataSourceView, 
	IStateManager

The SqlDataSourceView type exposes the following members.

  NameDescription
Public methodSqlDataSourceViewInitializes a new instance of the SqlDataSourceView class setting the specified SqlDataSource control as the owner of the current view.
Top

  NameDescription
Public propertyCancelSelectOnNullParameterGets or sets a value indicating whether a data retrieval operation is canceled when any parameter that is contained in the SelectParameters collection evaluates to null.
Public propertyCanDeleteGets a value indicating whether the SqlDataSourceView object that is associated with the current SqlDataSource control supports the delete operation. (Overrides DataSourceView.CanDelete.)
Public propertyCanInsertGets a value indicating whether the SqlDataSourceView object that is associated with the current SqlDataSource control supports the insert operation. (Overrides DataSourceView.CanInsert.)
Public propertyCanPageGets a value indicating whether the SqlDataSourceView object that is associated with the current SqlDataSource control supports the paging of retrieved data. (Overrides DataSourceView.CanPage.)
Public propertyCanRetrieveTotalRowCountGets a value indicating whether the SqlDataSourceView object that is associated with the current SqlDataSource control supports retrieving the total number of data rows, in addition to the set of data. (Overrides DataSourceView.CanRetrieveTotalRowCount.)
Public propertyCanSortGets a value indicating whether the SqlDataSourceView object that is associated with the current SqlDataSource control supports a sorted view on the retrieved data. (Overrides DataSourceView.CanSort.)
Public propertyCanUpdateGets a value indicating whether the SqlDataSourceView object that is associated with the current SqlDataSource control supports the update operation. (Overrides DataSourceView.CanUpdate.)
Public propertyConflictDetectionGets or sets the value indicating how the SqlDataSource control performs updates and deletes when data in a row in the underlying database changes during the time of the operation.
Public propertyDeleteCommandGets or sets the SQL string that the SqlDataSourceView uses to delete data from the underlying database.
Public propertyDeleteCommandTypeGets or sets a value indicating whether the text in the DeleteCommand property is a SQL statement or the name of a stored procedure.
Public propertyDeleteParametersGets the parameters collection containing the parameters that are used by the DeleteCommand property.
Protected propertyEventsGets a list of event-handler delegates for the data source view. (Inherited from DataSourceView.)
Public propertyFilterExpressionGets or sets a filtering expression that is applied when the Select method is called.
Public propertyFilterParametersGets a collection of parameters that are associated with any parameter placeholders in the FilterExpression string.
Public propertyInsertCommandGets or sets the SQL string that the SqlDataSourceView object uses to insert data into the underlying database.
Public propertyInsertCommandTypeGets or sets a value indicating whether the text in the InsertCommand property is a SQL statement or the name of a stored procedure.
Public propertyInsertParametersGets the parameters collection containing the parameters that are used by the InsertCommand property.
Protected propertyIsTrackingViewStateGets a value indicating whether the SqlDataSourceView object is saving changes to its view state.
Public propertyNameGets the name of the data source view. (Inherited from DataSourceView.)
Public propertyOldValuesParameterFormatStringGets or sets a format string to apply to the names of any parameters that are passed to the Delete or Update method.
Protected propertyParameterPrefixGets the string that is used to prefix a parameter placeholder in a parameterized SQL query.
Public propertySelectCommandGets or sets the SQL string that the SqlDataSourceView object uses to retrieve data from the underlying database.
Public propertySelectCommandTypeGets or sets a value indicating whether the text in the SelectCommand property is a SQL query or the name of a stored procedure.
Public propertySelectParametersGets the parameters collection containing the parameters that are used by the SelectCommand property.
Public propertySortParameterNameGets or sets the name of a stored procedure parameter that is used to sort retrieved data when data retrieval is performed using a stored procedure.
Public propertyUpdateCommandGets or sets the SQL string that the SqlDataSourceView object uses to update data in the underlying database.
Public propertyUpdateCommandTypeGets or sets a value indicating whether the text in the UpdateCommand property is a SQL statement or the name of a stored procedure.
Public propertyUpdateParametersGets the parameters collection containing the parameters that are used by the UpdateCommand property.
Top

  NameDescription
Public methodCanExecuteDetermines whether the specified command can be executed. (Inherited from DataSourceView.)
Public methodDelete(IDictionary, IDictionary)Performs a delete operation using the DeleteCommand SQL string, any parameters that are specified in the DeleteParameters collection, and the values that are in the specified keys and oldValues collections.
Public methodDelete(IDictionary, IDictionary, DataSourceViewOperationCallback)Performs an asynchronous delete operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodExecuteCommand(String, IDictionary, IDictionary)Executes the specified command. (Inherited from DataSourceView.)
Public methodExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)Executes the specified command. (Inherited from DataSourceView.)
Protected methodExecuteDeletePerforms a delete operation using the DeleteCommand SQL string, any parameters that are specified in the DeleteParameters collection, and the values that are in the specified keys and oldValues collections. (Overrides DataSourceView.ExecuteDelete(IDictionary, IDictionary).)
Protected methodExecuteInsertPerforms an insert operation using the InsertCommand SQL string, any parameters that are specified in the InsertParameters collection, and the values that are in the specified values collection. (Overrides DataSourceView.ExecuteInsert(IDictionary).)
Protected methodExecuteSelectRetrieves data from the underlying database using the SelectCommand SQL string and any parameters that are in the SelectParameters collection. (Overrides DataSourceView.ExecuteSelect(DataSourceSelectArguments).)
Protected methodExecuteUpdatePerforms an update operation using the UpdateCommand SQL string, any parameters that are in the UpdateParameters collection, and the values that are in the specified keys, values, and oldValues collections. (Overrides DataSourceView.ExecuteUpdate(IDictionary, IDictionary, IDictionary).)
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.)
Public methodInsert(IDictionary)Performs an insert operation using the InsertCommand SQL string, any parameters that are specified in the InsertParameters collection, and the values that are in the specified values collection.
Public methodInsert(IDictionary, DataSourceViewOperationCallback)Performs an asynchronous insert operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Protected methodLoadViewStateRestores the previously saved view state for the data source view.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnDataSourceViewChangedRaises the DataSourceViewChanged event. (Inherited from DataSourceView.)
Protected methodOnDeletedRaises the Deleted event after the SqlDataSource control has completed a delete operation.
Protected methodOnDeletingRaises the Deleting event before the SqlDataSource control attempts a delete operation.
Protected methodOnFilteringRaises the Filtering event before the SqlDataSource control filters the results of a select operation.
Protected methodOnInsertedRaises the Inserted event after the SqlDataSource control has completed an insert operation.
Protected methodOnInsertingRaises the Inserting event before the SqlDataSource control attempts an insert operation.
Protected methodOnSelectedRaises the Selected event after the SqlDataSource control has completed a data retrieval operation.
Protected methodOnSelectingRaises the Selecting event before the SqlDataSource control attempts a data retrieval operation.
Protected methodOnUpdatedRaises the Updated event after the SqlDataSource control has completed an update operation.
Protected methodOnUpdatingRaises the Updating event before the SqlDataSource control attempts an update operation.
Protected methodRaiseUnsupportedCapabilityErrorCompares the capabilities that are requested for an ExecuteSelect operation against those that the view supports and is called by the RaiseUnsupportedCapabilitiesError method. (Overrides DataSourceView.RaiseUnsupportedCapabilityError(DataSourceCapabilities).)
Protected methodSaveViewStateSaves the changes to the view state for the SqlDataSourceView control since the time that the page was posted back to the server.
Public methodSelect(DataSourceSelectArguments)Retrieves data from the underlying database using the SelectCommand SQL string and any parameters that are in the SelectParameters collection.
Public methodSelect(DataSourceSelectArguments, DataSourceViewSelectCallback)Gets a list of data asynchronously from the underlying data storage. (Inherited from DataSourceView.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTrackViewStateCauses the SqlDataSourceView object to track changes to its view state so that the changes can be stored in the StateBag object for the control and persisted across requests for the same page.
Public methodUpdate(IDictionary, IDictionary, IDictionary)Performs an update operation using the UpdateCommand SQL string, any parameters that are in the UpdateParameters collection, and the values that are in the specified keys, values, and oldValues collections.
Public methodUpdate(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback)Performs an asynchronous update operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Top

  NameDescription
Public eventDataSourceViewChangedOccurs when the data source view has changed. (Inherited from DataSourceView.)
Public eventDeletedOccurs when a delete operation has completed.
Public eventDeletingOccurs before a delete operation.
Public eventFilteringOccurs before a filter operation.
Public eventInsertedOccurs when an insert operation has completed.
Public eventInsertingOccurs before an insert operation.
Public eventSelectedOccurs when a data retrieval operation has completed.
Public eventSelectingOccurs before a data retrieval operation.
Public eventUpdatedOccurs when an update operation has completed.
Public eventUpdatingOccurs before an update operation.
Top

  NameDescription
Explicit interface implemetationPrivate propertyIStateManager.IsTrackingViewStateFor a description of this member, see IsTrackingViewState.
Explicit interface implemetationPrivate methodIStateManager.LoadViewStateInfrastructure. For a description of this member, see IStateManager.LoadViewState(Object).
Explicit interface implemetationPrivate methodIStateManager.SaveViewStateInfrastructure. For a description of this member, see IStateManager.SaveViewState().
Explicit interface implemetationPrivate methodIStateManager.TrackViewStateInfrastructure. For a description of this member, see TrackViewState.
Top

The SqlDataSourceView class is intended primarily to be used by data-bound controls, and not as a programmable object in page code.

ASP.NET data source controls contain one or more lists of data, represented by data source view objects. The SqlDataSourceView class extends the DataSourceView class, defines the capabilities of the SqlDataSource control with which it is associated, and implements the basic data functionality for the data source control. The SqlDataSourceView class implements the data functionality for the SqlDataSource control, including the Select, Update, Insert, and Delete operations, sorting, filtering, and managing settings that are kept in view state.

Although the SqlDataSourceView object is not directly exposed to page developers by the SqlDataSource control, many of its properties are. The most basic operation that a data source view performs is data retrieval from the underlying database using the Select method, which retrieves an IEnumerable collection of data items. The SqlDataSourceView class implements data retrieval from relational databases using SQL queries. The SQL queries can be parameterized for greater flexibility and security. The following data retrieval methods, properties, and events are implemented by the SqlDataSourceView and exposed directly by its SqlDataSource control to page developers and other callers:

The SqlDataSourceView object supports updating data in a relational database using SQL commands. The SQL commands can be parameterized for greater flexibility and security. Data-bound controls, such as the GridView and DetailsView, can be configured to perform updates automatically using the SqlDataSourceView, while other controls cannot. The following update methods, properties, and events are implemented by the SqlDataSourceView and exposed directly by its SqlDataSource control to page developers and other callers:

The SqlDataSourceView supports inserting new rows of data into a relational database. The SQL commands that are specified in the InsertCommand property can be parameterized for greater flexibility and security. Data-bound controls, such as the GridView and DetailsView, can be configured to perform inserts automatically using the SqlDataSourceView, while other controls cannot. The following insert methods, properties, and events are implemented by the SqlDataSourceView and exposed directly by its SqlDataSource control to page developers and other callers:

The SqlDataSourceView object also supports deleting data from a relational database. As with other commands, the SQL commands that are specified in the DeleteCommand property can be parameterized for greater flexibility and security. Data-bound controls, such as the GridView and DetailsView, can be configured to perform deletes automatically using the SqlDataSourceView, while other controls cannot. The following delete methods, properties, and events are implemented by the SqlDataSourceView and exposed directly by its SqlDataSource control to page developers and other callers:

Data retrieval is more powerful when the clause that is used to filter the data during data retrieval is dynamic. In other words, an SQL query with a static WHERE clause is not as flexible and powerful as an SQL query where the values in the WHERE clause are bound to values that can change, such as values that are displayed in controls on a Web Forms page. Instead of rebuilding an SQL query and setting the SelectCommand property on every page load, you can use the FilterExpression and FilterParameters properties to apply dynamic filtering to data retrieval. These properties are implemented by the SqlDataSourceView and exposed directly by its SqlDataSource control to data-bound controls and other callers.

You can sort the data that you retrieve with the SqlDataSource control by adding an ORDER BY clause, which causes the database to perform the ordering for you when you retrieve data or by ordering the data in memory after it is retrieved. You can supply a sorting expression to the SqlDataSourceView by setting the SortExpression property of the DataSourceSelectArguments object that is passed to the Select method. The syntax for the SortExpression property is the same as the syntax for a DataView.Sort property. If you use a stored procedure to retrieve data, you can also use the SortParameterName property to specify a parameter that is used specifically for sorting the results of a stored procedure call.

When more than one user can change the database concurrently, there is the potential for concurrency conflict. The SqlDataSource control has controls concurrency through the SqlDataSource.ConflictDetection property. The functionality is implemented in the SqlDataSourceView.ConflictDetection property.

Like many other Web server controls, the SqlDataSourceView implements the IStateManager interface and uses view state to track its state across page requests. Implementations of the IsTrackingViewState and property and the LoadViewState, SaveViewState, and TrackViewState methods are provided to enable view state tracking for the control. For more information, see ASP.NET State Management Overview.

.NET Framework

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

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft