Group Class
See Also  Members  
Xceed.Grid Assembly > Xceed.Grid Namespace : Group Class


Represents a group in the grid.

Syntax

Visual Basic (Declaration) 
<ToolboxItemAttribute(ToolboxItemType=, ToolboxItemTypeName="")>
<DefaultPropertyAttribute("GroupBy")>
<DescriptionAttribute("A group in the grid.")>
<DesignerAttribute(DesignerBaseTypeName="System.ComponentModel.Design.IDesigner", DesignerTypeName="Xceed.Grid.Design.GroupDesigner,Xceed.Grid.v3.9.Design,Version=3.9.10173.00005,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")>
<DefaultEventAttribute("DataRowsChanged")>
Public Class Group 
   Inherits GroupBase
Visual Basic (Usage)Copy Code
Dim instance As Group
C# 
[ToolboxItemAttribute(ToolboxItemType=, ToolboxItemTypeName="")]
[DefaultPropertyAttribute("GroupBy")]
[DescriptionAttribute("A group in the grid.")]
[DesignerAttribute(DesignerBaseTypeName="System.ComponentModel.Design.IDesigner", DesignerTypeName="Xceed.Grid.Design.GroupDesigner,Xceed.Grid.v3.9.Design,Version=3.9.10173.00005,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")]
[DefaultEventAttribute("DataRowsChanged")]
public class Group : GroupBase

Remarks

Any changes made to the grid's grouping using the GroupByRow results in the recreation of the group templates. This means that you cannot keep a long term reference on a specific group in the group templates and that, in code, a group used as a template should not be accessed using its component name (gridControl1.GroupTemplates[ 0 ] should be used rather than group1).

DataRows can be grouped automatically or manually. To do automatic grouping, the GroupBy property of a group must be set to the Column.FieldName of the column in the grid by which the DataRows are to be grouped. To group the data rows manually, the QueryGroupKeys event can be used. This event can be used in conjunction with the GroupBy property to provide additional custom grouping criteria.

Groups by themselves do not have a visual representation. In order for groups to have a visual representation, they usually contain at least one row that is not a data row in their header or footer sections. Typically, a GroupManagerRow is added to the GroupBase.HeaderRows of a group to create an Outlook style grid.

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      Xceed.Grid.GridElementBase
         Xceed.Grid.GridElement
            Xceed.Grid.GroupBase
               Xceed.Grid.Group

Requirements

Target Platforms: Windows 2000, Windows XP SP3 Family, Windows Server 2003-2008 Family, Windows Vista, Windows 7

See Also