DataSourceSelectArguments.MaximumRows Property

Definition

Gets or sets a value that represents the maximum number of data rows that a data source control returns for a data retrieval operation.

public:
 property int MaximumRows { int get(); void set(int value); };
public int MaximumRows { get; set; }
member this.MaximumRows : int with get, set
Public Property MaximumRows As Integer

Property Value

The maximum number of data rows that a data source returns for a data retrieval operation. The default value is 0, which indicates that all possible data rows are returned.

Remarks

The MaximumRows property supports paging scenarios. Data-bound controls check a data source view's CanPage property at run time, and add a DataSourceCapabilities.Page capability using the AddSupportedCapabilities(DataSourceCapabilities) method if the view supports paging. If the data-bound control fails to add the capability, and the paging properties are set on a DataSourceSelectArguments object passed to the data source view during a data retrieval operation, an InvalidOperationException exception might be thrown.

The data-bound control can request a subset of data from a data source control for paging by setting the StartRowIndex and MaximumRows properties on the DataSourceSelectArguments object passed to the Select(DataSourceSelectArguments, DataSourceViewSelectCallback) 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