BaseDataList.DataSourceID Property

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.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 or sets the ID property of the data source control that the data listing control should use to retrieve its data source.

public:
 virtual property System::String ^ DataSourceID { System::String ^ get(); void set(System::String ^ value); };

[System.Web.UI.Themeable(false)]
public virtual string DataSourceID { get; set; }

[<System.Web.UI.Themeable(false)>]
member this.DataSourceID : string with get, set

Public Overridable Property DataSourceID As String

Property Value

String

The programmatic identifier assigned to the data source control.

Attributes: ThemeableAttribute

Exceptions

HttpException

The data source cannot be resolved because a value is specified for both the DataSource property and the DataSourceID property.

Remarks

Use the DataSourceID property to access the ID property of the data source control that the data listing control should use to retrieve its data source. The data source control referenced by the DataSourceID property can be any control that implements the IDataSource interface. The data source control must exist either in the same naming container as the data listing control that references it, or in a parent control of the data listing control. When you specify a value for this property, the data listing control automatically binds to the specified data source control. You do not need to write code that explicitly calls the DataBind method.

Alternately, you can use the DataSource property to specify the source of values to bind to a data listing control. The data source must be a collection that implements the System.Collections.IEnumerable interface (such as System.Data.DataView, System.Collections.ArrayList, or System.Collections.Generic.List<T>) or the IListSource interface to bind to a control derived from the BaseDataList class. When you set the DataSource property, you must manually write the code to perform data binding.

If values are specified for both the DataSource property and the DataSourceID property, ASP.NET is not able to resolve the data source and an System.Web.HttpException exception is thrown.

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

Applies to

Deila með