ASPxGridView.GroupCount Property

Gets how many columns are used to group data.

Assembly: DevExpress.Web.v20.2.dll

Declaration

C#
VB.NET

public int GroupCount { get; }

Public ReadOnly Property GroupCount As Integer

Property Value

Type	Description
Int32	An integer value that indicates the number of columns used to group data.

Remarks

The grouped columns can be obtained using the ASPxGridView.GetGroupedColumns method.

Example

In this example, we have an ASPxGrid bound to SqlDataSource. The data source returns columns. We grouped the grid by one of them. Also, the grid contains an additional unbound column 'percent'. It contains the ratio of the 'UnitPrice' column's value to total 'UnitPrice' column's values for this group. If the grid doesn't have any groups, the 'percent' column will contain the ratio of the 'UnitPrice' column's value to total 'UnitPrice' column's values of the grid.

View Example

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>


<%@ Register Assembly="DevExpress.Web.ASPxEditors.v10.2, Version=10.2.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxEditors" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.ASPxGridView.v10.2, Version=10.2.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxGridView" TagPrefix="dx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
        <div>
            <dx:ASPxGridView ID="grid" runat="server" AutoGenerateColumns="False" DataSourceID="sds"
                KeyFieldName="ProductID" OnCustomUnboundColumnData="grid_CustomUnboundColumnData">
                <TotalSummary>
                    <dx:ASPxSummaryItem DisplayFormat="c2" FieldName="UnitPrice" SummaryType="Sum" />
                </TotalSummary>
                <GroupSummary>
                    <dx:ASPxSummaryItem DisplayFormat="c2" FieldName="UnitPrice" 
                        ShowInGroupFooterColumn="UnitPrice" SummaryType="Sum" />
                </GroupSummary>
                <Columns>
                    <dx:GridViewDataTextColumn FieldName="ProductID" ReadOnly="True" VisibleIndex="0">
                        <EditFormSettings Visible="False" />
                    </dx:GridViewDataTextColumn>
                    <dx:GridViewDataTextColumn FieldName="ProductName" VisibleIndex="1">
                    </dx:GridViewDataTextColumn>
                    <dx:GridViewDataTextColumn FieldName="CategoryID" GroupIndex="0" SortIndex="0" SortOrder="Ascending"
                        VisibleIndex="2">
                    </dx:GridViewDataTextColumn>
                    <dx:GridViewDataTextColumn FieldName="UnitPrice" VisibleIndex="3">
                        <PropertiesTextEdit DisplayFormatString="c2">
                        </PropertiesTextEdit>
                    </dx:GridViewDataTextColumn>
                    <dx:GridViewDataTextColumn FieldName="percent" UnboundType="Decimal" VisibleIndex="3">
                        <PropertiesTextEdit DisplayFormatString="p2">
                        </PropertiesTextEdit>
                        <EditFormSettings Visible="False" />
                    </dx:GridViewDataTextColumn>
                </Columns>
                <Settings ShowFooter="True" ShowGroupFooter="VisibleIfExpanded" ShowGroupPanel="True" />
            </dx:ASPxGridView>
            <asp:SqlDataSource ID="sds" runat="server" ConnectionString="<%$ ConnectionStrings:NorthwindConnectionString %>"
                SelectCommand="SELECT TOP 20 [ProductID], [ProductName], [CategoryID], [UnitPrice] FROM [Products]"></asp:SqlDataSource>
        </div>
    </form>
</body>
</html>

using System;
using System.Data;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class _Default : System.Web.UI.Page
{
    protected void grid_CustomUnboundColumnData(object sender, DevExpress.Web.ASPxGridView.ASPxGridViewColumnDataEventArgs e) {
        if (e.Column.FieldName == "percent") {
            if ((grid.GroupCount > 0)) {
                string itemKeyValue = e.GetListSourceFieldValue("ProductID").ToString();
                object summaryValue = grid.GetGroupSummaryValue(GetGroupIndex(itemKeyValue), grid.GroupSummary[0]);
                if (summaryValue != null)
                    e.Value = (decimal)e.GetListSourceFieldValue("UnitPrice") / (decimal)summaryValue;
            }
            else {
                e.Value = (decimal)e.GetListSourceFieldValue("UnitPrice") / (decimal)grid.GetTotalSummaryValue(grid.TotalSummary[0]);
            }

        }
    }

    protected int GetGroupIndex(string itemKeyValue) {
        int itemIndex = grid.FindVisibleIndexByKeyValue(itemKeyValue);        
        for (int i = itemIndex - 1; i >= 0; i += -1) {
            if (grid.IsGroupRow(i))
                return i; 
        }
        return -1;
    }

}

Imports Microsoft.VisualBasic
Imports System
Imports System.Data
Imports System.Configuration
Imports System.Collections
Imports System.Web
Imports System.Web.Security
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Imports System.Web.UI.HtmlControls

Partial Public Class _Default
    Inherits System.Web.UI.Page
    Protected Sub grid_CustomUnboundColumnData(ByVal sender As Object, ByVal e As DevExpress.Web.ASPxGridView.ASPxGridViewColumnDataEventArgs)
        If e.Column.FieldName = "percent" Then
            If (grid.GroupCount > 0) Then
                Dim itemKeyValue As String = e.GetListSourceFieldValue("ProductID").ToString()
                Dim summaryValue As Object = grid.GetGroupSummaryValue(GetGroupIndex(itemKeyValue), grid.GroupSummary(0))
                If summaryValue IsNot Nothing Then
                    e.Value = CDec(e.GetListSourceFieldValue("UnitPrice")) / CDec(summaryValue)
                End If
            Else
                e.Value = CDec(e.GetListSourceFieldValue("UnitPrice")) / CDec(grid.GetTotalSummaryValue(grid.TotalSummary(0)))
            End If

        End If
    End Sub

    Protected Function GetGroupIndex(ByVal itemKeyValue As String) As Integer
        Dim itemIndex As Integer = grid.FindVisibleIndexByKeyValue(itemKeyValue)
        Dim i As Integer = itemIndex - 1
        Do While i >= 0
            If grid.IsGroupRow(i) Then
                Return i
            End If
            i += -1
        Loop
        Return -1
    End Function

End Class

<%@ Page Language="vb" AutoEventWireup="true" CodeFile="Default.aspx.vb" Inherits="_Default" %>


<%@ Register Assembly="DevExpress.Web.ASPxEditors.v10.2, Version=10.2.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxEditors" TagPrefix="dx" %>
<%@ Register Assembly="DevExpress.Web.ASPxGridView.v10.2, Version=10.2.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web.ASPxGridView" TagPrefix="dx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
        <div>
            <dx:ASPxGridView ID="grid" runat="server" AutoGenerateColumns="False" DataSourceID="sds"
                KeyFieldName="ProductID" OnCustomUnboundColumnData="grid_CustomUnboundColumnData">
                <TotalSummary>
                    <dx:ASPxSummaryItem DisplayFormat="c2" FieldName="UnitPrice" SummaryType="Sum" />
                </TotalSummary>
                <GroupSummary>
                    <dx:ASPxSummaryItem DisplayFormat="c2" FieldName="UnitPrice" 
                        ShowInGroupFooterColumn="UnitPrice" SummaryType="Sum" />
                </GroupSummary>
                <Columns>
                    <dx:GridViewDataTextColumn FieldName="ProductID" ReadOnly="True" VisibleIndex="0">
                        <EditFormSettings Visible="False" />
                    </dx:GridViewDataTextColumn>
                    <dx:GridViewDataTextColumn FieldName="ProductName" VisibleIndex="1">
                    </dx:GridViewDataTextColumn>
                    <dx:GridViewDataTextColumn FieldName="CategoryID" GroupIndex="0" SortIndex="0" SortOrder="Ascending"
                        VisibleIndex="2">
                    </dx:GridViewDataTextColumn>
                    <dx:GridViewDataTextColumn FieldName="UnitPrice" VisibleIndex="3">
                        <PropertiesTextEdit DisplayFormatString="c2">
                        </PropertiesTextEdit>
                    </dx:GridViewDataTextColumn>
                    <dx:GridViewDataTextColumn FieldName="percent" UnboundType="Decimal" VisibleIndex="3">
                        <PropertiesTextEdit DisplayFormatString="p2">
                        </PropertiesTextEdit>
                        <EditFormSettings Visible="False" />
                    </dx:GridViewDataTextColumn>
                </Columns>
                <Settings ShowFooter="True" ShowGroupFooter="VisibleIfExpanded" ShowGroupPanel="True" />
            </dx:ASPxGridView>
            <asp:SqlDataSource ID="sds" runat="server" ConnectionString="<%$ ConnectionStrings:NorthwindConnectionString %>"
                SelectCommand="SELECT TOP 20 [ProductID], [ProductName], [CategoryID], [UnitPrice] FROM [Products]"></asp:SqlDataSource>
        </div>
    </form>
</body>
</html>

The following code snippets (auto-collected from DevExpress Examples) contain references to the GroupCount property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#
VB.NET

gridview-how-to-display-a-group-summary-in-group-headers-t446118/CS/Sample/Controllers/GridGroupRowContentTemplate.cs#L26


private static int IndentCount { get { return Grid.GroupCount - GroupLevel - 1; } }
private static int GroupLevel { get { return Grid.DataBoundProxy.GetRowLevel(Container.VisibleIndex); } }

how-to-export-grouped-grid-with-page-breaks-between-groups-e1597/VB/WebApplication211/Default.aspx.vb#L24

Protected Sub ASPxButton1_Click(ByVal sender As Object, ByVal e As EventArgs)
    If ASPxGridView1.GroupCount = 0 Then
        ASPxGridViewExporter1.WritePdfToResponse()

gridview-how-to-display-a-group-summary-in-group-headers-t446118/VB/Sample_VB/Controllers/GridGroupRowContentTemplate.vb#L22

Get
    Return Grid.GroupCount - GroupLevel - 1
End Get

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

ASPxGridView.GroupCount Property

Declaration

Property Value

Remarks

Example

ASPxGridView.GroupCount Property

Declaration

Property Value

Remarks

Example

Related GitHub Examples