BaseDataBoundControl.DataSource Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the object from which the data-bound control retrieves its list of data items.

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

<BindableAttribute(True)> _
<ThemeableAttribute(False)> _
Public Overridable Property DataSource As Object
Dim instance As BaseDataBoundControl
Dim value As Object

value = instance.DataSource

instance.DataSource = value
/** @property */
public Object get_DataSource ()

/** @property */
public void set_DataSource (Object value)

public function get DataSource () : Object

public function set DataSource (value : Object)

Property Value

An object that represents the data source from which the data-bound control retrieves its data. The default is a null reference (Nothing in Visual Basic).

When you set the DataSource property, the ValidateDataSource method is called. In addition, if the data-bound control has already been initialized, the OnDataPropertyChanged method is called to set the RequiresDataBinding property to true.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins Overview.

The following code example demonstrates how the DataSource property of a data-bound control is used. In this example, the GridView control is bound to a DataSet object. After the DataSource property is set, the DataBind method is called explicitly.

<%@ Page language="VB" %>
<%@ import namespace="System.Data" %>
<%@ import namespace="System.Data.SqlClient" %>

<script runat="server">

  Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    ' This example uses Microsoft SQL Server and connects
    ' to the Northwind sample database. The data source needs
    ' to be bound to the GridView control only when the 
    ' page is first loaded. Thereafter, the values are
    ' stored in view state.                      
    If Not IsPostBack Then
      ' Declare the query string.
      Dim queryString As String = _
        "Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
      ' Run the query and bind the resulting DataSet
      ' to the GridView control.
      Dim ds As DataSet = GetData(queryString)
      If (ds.Tables.Count > 0) Then
        AuthorsGridView.DataSource = ds
        Message.Text = "Unable to connect to the database."
      End If
    End If
  End Sub
  Function GetData(ByVal queryString As String) As DataSet
    ' Retrieve the connection string stored in the Web.config file.
    Dim connectionString As String = ConfigurationManager.ConnectionStrings("NorthWindConnectionString").ConnectionString
    Dim ds As New DataSet()

      ' Connect to the database and run the query.
      Dim connection As New SqlConnection(connectionString)
      Dim adapter As New SqlDataAdapter(queryString, Connection)
      ' Fill the DataSet.
    Catch ex As Exception
      ' The connection failed. Display an error message.
      Message.Text = "Unable to connect to the database."
    End Try
    Return ds
  End Function

    <form runat="server">
      <h3>GridView DataBind Example</h3>
      <asp:label id="Message"

      <asp:gridview id="AuthorsGridView" 

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0