Retrieves data from the underlying database by using the SelectCommand SQL string and any parameters that are in the SelectParameters collection.
Namespace:
System.Web.UI.WebControls
Assembly:
System.Web (in System.Web.dll)
'Usage
Dim instance As SqlDataSource
Dim arguments As DataSourceSelectArguments
Dim returnValue As IEnumerable
returnValue = instance.Select(arguments)
'Declaration
Public Function Select ( _
arguments As DataSourceSelectArguments _
) As IEnumerable
The Select method is automatically called during the PreRender phase of the page life cycle. It is called by data-bound controls that have been attached to a SqlDataSource control through their DataSourceID property.
The Select method returns a DataView object if the DataSourceMode property is set to the DataSet value. The Select method returns a IDataReader object if the DataSourceMode property is set to the DataReader value. Close the IDataReader object when you have finished reading the data.
Before the Select operation is performed, the OnSelecting method is called to raise the Selecting event. You can handle this event to examine the values of the parameters and to perform any processing before the Select operation.
After the Select operation completes, the OnSelected method is called to raise the Selected event. You can handle this event to examine any return values and error codes and to perform any post-processing.
If the DataSourceMode property is set to SqlDataSourceMode..::.DataSet and caching is enabled, the SqlDataSource object retrieves data from and saves data to the cache during the Select operation. The cache is created, discarded, or refreshed based on the caching behavior that is specified by the combination of the CacheDuration and CacheExpirationPolicy properties.
Security Note: |
|---|
When you are using client impersonation under Microsoft Windows authentication, the data is cached when the first user accesses the data. If another user requests the same data, the data is retrieved from the cache. The data is not retrieved by making another call to the database to verify the user's access to the data. If you expect more than one user to access the data, and you want each retrieval of data to be verified by the security configurations for the database, do not use caching. |
If the DataSourceMode property is set to SqlDataSourceMode..::.DataSet and a FilterExpression property has been specified, the filter expression is evaluated with any supplied FilterParameters properties and the resulting filter is applied to the list of data during the Select operation.
The Select method delegates to the Select method of the SqlDataSourceView object that is associated with the SqlDataSource control. To perform a data retrieval operation, the SqlDataSourceView builds a DbCommand object by using the SelectCommand text and any associated SelectParameters values, and then executes the DbCommand against the underlying database.
Security Note: |
|---|
Values are inserted into parameters without validation, which is a potential security threat. Use the Filtering event to validate parameter values before executing the query. For more information, see Script Exploits Overview. |
The following examples show how to programmatically call the Select method and set values based on the result of the query. The following example shows the declarative code for the Web controls.
<asp:SqlDataSource
ID="SqlDataSource1"
runat="server"
ConnectionString="<%$ ConnectionStrings:ConnectionString %>"
SelectCommand="SELECT Count(*) FROM [Products] WHERE ([ReorderLevel] > 0)">
</asp:SqlDataSource>
<asp:Label
ID="Label1"
runat="server"
Text="">
</asp:Label>
<br />
<asp:Button
ID="Button1"
Text="Check Reorder Status"
runat="server"
onclick="Button1_Click" />
The following example shows how to programmatically call the Select method. The SqlDataSource control returns an integer. The value of the integer is used to set the text of a Label control and to determine whether to display a HyperLink control.
Protected Sub CheckReorderStatus()
Dim dv As DataView
Dim reorderedProducts As Integer
dv = CType(SqlDataSource1.Select(DataSourceSelectArguments.Empty), DataView)
reorderedProducts = CType(dv.Table.Rows(0)(0), Integer)
If (reorderedProducts > 0) Then
Label1.Text = "Number of products on reorder: " & reorderedProducts
Else
Label1.Text = "No products on reorder."
End If
End Sub
Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)
CheckReorderStatus()
End Sub
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0
Reference
Other Resources