Edit

DataSourceSelectArguments.RetrieveTotalRowCount Property

  • Reference

Definition

Namespace:
System.Web.UI
Assembly:
System.Web.dll

Gets or sets a value indicating whether a data source control should retrieve a count of all the data rows during a data retrieval operation.

public:
 property bool RetrieveTotalRowCount { bool get(); void set(bool value); };
public bool RetrieveTotalRowCount { get; set; }
member this.RetrieveTotalRowCount : bool with get, set
Public Property RetrieveTotalRowCount As Boolean

Property Value

Boolean

true if the data source control should retrieve a total data row count; otherwise, false.

Remarks

The RetrieveTotalRowCount property supports paging scenarios. Set this property to true to request a total row count from the data source control during the data-retrieval operation. Check the DataSourceView.CanRetrieveTotalRowCount property to determine whether a data source view supports retrieving a total row count. If the data source supports it, the TotalRowCount property is set by the data source control during the course of a data retrieval operation and the total data row count is returned in the TotalRowCount property, much as a value is returned in an output parameter of a method.

Important

If any of the DataSourceSelectArguments properties are set, but the currently bound data source control does not support the requested capability, an InvalidOperationException exception is thrown when the DataSourceSelectArguments.RaiseUnsupportedCapabilitiesError(DataSourceView) method is called.

Applies to

See also