DataSourceView.CanSort Property

Reference

Definition

Namespace:: System.Web.UI

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 a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports a sorted view on the underlying data source.

public:
 virtual property bool CanSort { bool get(); };

public virtual bool CanSort { get; }

member this.CanSort : bool

Public Overridable ReadOnly Property CanSort As Boolean

Property Value

Boolean

true if the operation is supported; otherwise, false. The default implementation returns false.

Examples

The following code example demonstrates how to override the CanSort property in a class that extends the DataSourceView class. This code example is part of a larger example provided for the DataSourceView class.

if (!string.IsNullOrEmpty(selectArgs.SortExpression)) {
    dataView.Sort = selectArgs.SortExpression;
}

If Not selectArgs.SortExpression Is String.Empty Then
    dataView.Sort = selectArgs.SortExpression
End If

Remarks

A data-bound control can request sorting by adding the Sort field to the DataSourceSelectArguments object passed to the ExecuteSelect method. If a data-bound control requests sorting, but the CanSort property returns false, the data source view throws an exception.

Applies to

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via