GridView.EnableSortingAndPagingCallbacks Property (System.Web.UI.WebControls)

EnableSortingAndPagingCallbacks Pro...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

GridView..::.EnableSortingAndPagingCallbacks Property

Gets or sets a value indicating whether client-side callbacks are used for sorting and paging operations.

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

Syntax

Visual Basic (Declaration)

Public Overridable Property EnableSortingAndPagingCallbacks As Boolean

Visual Basic (Usage)

Dim instance As GridView
Dim value As Boolean

value = instance.EnableSortingAndPagingCallbacks

instance.EnableSortingAndPagingCallbacks = value

public virtual bool EnableSortingAndPagingCallbacks { get; set; }

Visual C++

public:
virtual property bool EnableSortingAndPagingCallbacks {
    bool get ();
    void set (bool value);
}

JScript

public function get EnableSortingAndPagingCallbacks () : boolean
public function set EnableSortingAndPagingCallbacks (value : boolean)

ASP.NET

<asp:GridView EnableSortingAndPagingCallbacks="True|False" />

Property Value

Type: System..::.Boolean
true to use client-side callbacks for sorting and paging operations; otherwise, false. The default is false.

Exceptions

Exception	Condition
NotSupportedException	The Columns collection contains a column that does not support callbacks, such as TemplateField.

Remarks

By default, when a sorting or paging operation is performed, the GridView control posts back to the server to perform the operation. When the EnableSortingAndPagingCallbacks property is set to true, a service is called on the client to perform sorting and paging operations, which eliminates the need to post back to the server.

Note:
Not all browsers support this feature. To determine whether a browser supports this feature, use the SupportsCallback property.

All columns in the Columns collection must support callbacks for this feature to work. If the Columns collection contains a column that does not support callbacks, such as TemplateField, a NotSupportedException exception is raised.

Examples

The following example demonstrates how to use the EnableSortingAndPagingCallbacks property to enable client-side callbacks for sorting and paging operations.

Visual Basic

<%@ Page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
  <head runat="server">
    <title>GridView EnableSortingAndPagingCallbacks Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>GridView EnableSortingAndPagingCallbacks Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true"
        allowsorting="true"
        enablesortingandpagingcallbacks="true"        
        runat="server">

      </asp:gridview>

      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>

    </form>
  </body>
</html>

<%@ Page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
  <head runat="server">
    <title>GridView EnableSortingAndPagingCallbacks Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>GridView EnableSortingAndPagingCallbacks Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true"
        allowsorting="true"
        enablesortingandpagingcallbacks="true"        
        runat="server">

      </asp:gridview>

      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>

    </form>
  </body>
</html>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

GridView Class

GridView Members

System.Web.UI.WebControls Namespace

AllowSorting

AllowPaging

ValidateSupportsCallback