ClearGroupByColumns Method (UltraGridLayout)

Removes all the group by columns from all the bands ungrouping all the rows.

Syntax

Visual Basic

'Declaration
 
Public Sub ClearGroupByColumns() 

C#

public void ClearGroupByColumns()

Example

Following code contains button click handlers for two buttons. One contains code that groups rows in band 0 of ultraGrid1 by two columns. The second button handler code ungroups the rows by calling ClearGroupByColumns method. To test the sample code, click on the button that groups rows by two columns first and then click the second button and see how it effects the UltraGrid.

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

  Private Sub Button75_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button75.Click

      ' Following code groups the rows by two columns.

      ' Ensure view style is set OutlookGroupBy.
      Me.UltraGrid1.DisplayLayout.ViewStyleBand = ViewStyleBand.OutlookGroupBy

      ' Group rows in band 0 by two columns.
      Dim band As UltraGridBand = Me.UltraGrid1.DisplayLayout.Bands(0)
      band.SortedColumns.Add(band.Columns(0), False, True)
      band.SortedColumns.Add(band.Columns(1), False, True)

  End Sub

  Private Sub Button76_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button76.Click

      ' Call ClearGroupByColumns to ungroup all the rows in the UltraGrid if they
      ' were grouped by any columns.
      Me.UltraGrid1.DisplayLayout.ClearGroupByColumns()

      ' Or you can clear group-by rows on a specific band.
      Me.ultraGrid1.DisplayLayout.Bands(0).ClearGroupByColumns()

  End Sub

C#

using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void button75_Click(object sender, System.EventArgs e)
{

	// Following code groups the rows by two columns.

	// Ensure view style is set OutlookGroupBy.
	this.ultraGrid1.DisplayLayout.ViewStyleBand = ViewStyleBand.OutlookGroupBy;

	// Group rows in band 0 by two columns.
	UltraGridBand band = this.ultraGrid1.DisplayLayout.Bands[0];
	band.SortedColumns.Add( band.Columns[0], false, true );
	band.SortedColumns.Add( band.Columns[1], false, true );

}

private void button76_Click(object sender, System.EventArgs e)
{

	// Call ClearGroupByColumns to ungroup all the rows in the UltraGrid if they
	// were grouped by any columns.
	this.ultraGrid1.DisplayLayout.ClearGroupByColumns( );

	// Or you can clear group-by rows on a specific band.
	this.ultraGrid1.DisplayLayout.Bands[0].ClearGroupByColumns( );

}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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