ObjectDataSource.MaximumRowsParameterName Property


Gets or sets the name of the business object data retrieval method parameter that is used to indicate the number of records to retrieve for data source paging support.

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

public string MaximumRowsParameterName { get; set; }

Property Value

Type: System.String

The name of the SelectMethod parameter that is used to indicate the number of records to retrieve. The default is "maximumRows".

The MaximumRowsParameterName property is used to support data source paging. For information about how paging is supported by the ObjectDataSource control, see EnablePaging.

The MaximumRowsParameterName property delegates to the MaximumRowsParameterName property of the ObjectDataSourceView object that is associated with the ObjectDataSource control.

The following three examples show a Web page, a code-behind page class, and a data-access class that enable the user to pick how many records are displayed in the page.

The Web page contains an ObjectDataSource control whose EnablePaging property is set to true. The SelectCountMethod property is set to the name of a method that returns the total number of records in the query. The MaximumRowsParameterName property and the StartRowIndexParameterName property are set to the names of the parameters that are used in the Select method. The page also contains a DropDownList control.

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title>ObjectDataSource Example</title>
    <form id="form1" runat="server">
    How many rows to display on this page:<br />
        <asp:ListItem Value="5"></asp:ListItem>
        <asp:ListItem Value="10" Selected="True"></asp:ListItem>
        <asp:ListItem Value="20"></asp:ListItem>




The second example shows a handler for the ListControl.SelectedIndexChanged event of the DropDownList control. The code in the handler sets the PageSize property to the user's selection.

protected void rowsToDisplay_SelectedIndexChanged(object sender, EventArgs e)
    GridView1.PageSize = int.Parse(rowsToDisplay.SelectedValue);

The third example shows the data access class that retrieves data from the Customers table. It includes a method named GetSubsetOfEmployees, which is assigned to the SelectMethod property of the ObjectDataSource control. The example also includes a method named GetEmployeeCount, which is assigned to the SelectCountMethod property of the ObjectDataSource control. The class uses LINQ to query the Customers table. The example requires a LINQ to SQL class that represents the Northwind database and Customers table. For more information, see How to: Create LINQ to SQL Classes in a Web Project.

public class CustomerLogic

    public List<Customer> GetSubsetOfEmployees(int startRows, int maxRows)
        NorthwindDataContext ndc = new NorthwindDataContext();
        var customerQuery = 
            from c in ndc.Customers
            select c;

        return customerQuery.Skip(startRows).Take(maxRows).ToList<Customer>();

    public int GetEmployeeCount()
        object cachedCount = HttpRuntime.Cache["TotalEmployeeCount"];
        if (cachedCount != null)
            return int.Parse(cachedCount.ToString());
            NorthwindDataContext ndc = new NorthwindDataContext();
            var totalNumberQuery =
                from c in ndc.Customers
                select c;

            int employeeCount = totalNumberQuery.Count();
            HttpRuntime.Cache.Add("TotalEmployeeCount", employeeCount, null, DateTime.Now.AddMinutes(5), Cache.NoSlidingExpiration, CacheItemPriority.Normal, null);
            return employeeCount;

.NET Framework
Available since 2.0
Return to top