AutoGenerateOrderByClause Property

LinqDataSource.AutoGenerateOrderByClause Property

.NET Framework (current version)
 

Gets or sets a value that indicates whether the LinqDataSource control dynamically creates an Order By clause based on values in the OrderByParameters collection.

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

member AutoGenerateOrderByClause : bool with get, set

Property Value

Type: System.Boolean

true if the LinqDataSource control creates the Order By clause; otherwise, false. The default is false.

When you set the AutoGenerateOrderByClause property to true, the LinqDataSource control dynamically creates an Order By clause that is based on the values in the OrderByParameters collection. The LinqDataSource control sorts the data by the first parameter and then additionally sorts the data for each additional parameter. Parameters that contain null or an empty value are not included in the Order By clause.

You do not set the OrderBy property when the AutoGenerateOrderByClause is set to true, because the parser dynamically creates the Order By clause. The LinqDataSource control throws an exception if the AutoGenerateOrderByClause is set to true and the OrderBy property is assigned values.

The following example shows a LinqDataSource control with the AutoGenerateOrderByClause set to true. A parameter is included in the OrderByParameters collection that orders the data based on the property name that a user selects from a DropDownList control.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.5
Return to top
Show:
© 2016 Microsoft