Xceed Grid for WinForms v4.3 Documentation
GroupBy Property


Xceed.Grid.v4.3 Assembly > Xceed.Grid Namespace > Group Class : GroupBy Property
Gets or sets the fieldname of the column in the grid by which the data bound rows are grouped.
Syntax
'Declaration
 
<DescriptionAttribute("The fieldname of the column in the grid by which the data bound rows are grouped.")>

<TypeConverterAttribute("Xceed.Grid.Design.GroupByConverter,Xceed.Grid.v4.3.Design,Version=4.3.20076.12375,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")>

<CategoryAttribute("Behavior")>

<MergablePropertyAttribute(False)>

<ApplyToDesignerAttribute(True)>

Public Property GroupBy As String
'Usage
 
Dim instance As Group

Dim value As String

 

instance.GroupBy = value

 

value = instance.GroupBy
[Description("The fieldname of the column in the grid by which the data bound rows are grouped.")]

[TypeConverter("Xceed.Grid.Design.GroupByConverter,Xceed.Grid.v4.3.Design,Version=4.3.20076.12375,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")]

[Category("Behavior")]

[MergableProperty(false)]

[ApplyToDesigner(true)]

public string GroupBy {get; set;}

Property Value

The fieldname of the column in the grid by which the data bound rows are grouped.
Remarks

If the GroupBy property is set to System.String.Empty, manual grouping can be provided using the QueryGroupKeys event. The QueryGroupKeys event can also be used to provide additional grouping criteria when the GroupBy property is set.

When creating custom groups, the GroupBy property must be set in order for the groups which are created manually using the QueryGroupKeys event to be sorted. These groups will be sorted in the same direction as the columns whose fieldname is set in the GroupBy property.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

Group Class
Group Members
CalculateKey Method