Infragistics(R) NetAdvantage(R) Windows Forms
GroupByBox Class
Members  Example  See Also  E-mail your feedback on this topic.
Infragistics.Win.UltraWinGrid Namespace : GroupByBox Class

Returns a reference to the GroupByBox object. This property is read-only at design-time and run-time.

Syntax

Visual Basic (Declaration) 
Public NotInheritable Class GroupByBox 
   Inherits SpecialBoxBase
   Implements Infragistics.Win.ISupportPresets 
C# 
public sealed class GroupByBox : SpecialBoxBase, Infragistics.Win.ISupportPresets  

Example

Following code configures the look of group-by-box in the ultragrid. Group-by-box is where the user can drag and drop columns to group rows by those columns.

Visual BasicCopy Code
Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

  Private Sub Button4_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button4.Click

      ' Set the view style to OutlookGroupBy. Without it, group by box won't
      ' show up.
      Me.UltraGrid1.DisplayLayout.ViewStyleBand = ViewStyleBand.OutlookGroupBy

      ' Set the group-by-box style to Compact to save space.
      Me.UltraGrid1.DisplayLayout.GroupByBox.Style = GroupByBoxStyle.Compact

      ' Set the appearance of the group-by-box.
      Me.UltraGrid1.DisplayLayout.GroupByBox.Appearance.BackColor = Color.White

      ' Set the group-by-box prompt. This text shows up in the group-by-box when
      ' there are no group-by columns.
      Me.UltraGrid1.DisplayLayout.GroupByBox.Prompt = "Drag and drop a column to group by that column."

      ' Set the back color and fore color of the prompt area.
      'Me.UltraGrid1.DisplayLayout.GroupByBox.PromptAppearance.BackColor = Color.LightGray
      Me.UltraGrid1.DisplayLayout.GroupByBox.PromptAppearance.ForeColor = Color.Maroon

      ' Set the border style to InsetSoft.
      Me.UltraGrid1.DisplayLayout.GroupByBox.BorderStyle = UIElementBorderStyle.InsetSoft

      ' Configure the buttons associated with grouped-by columns. When a column
      ' is dragged and dropped in the group-by-box, the rows get grouped by the
      ' column and the column becomes a group-by column.
      '
      Me.UltraGrid1.DisplayLayout.GroupByBox.ButtonBorderStyle = UIElementBorderStyle.RaisedSoft

      ' Change the band labels. By setting it to
      ' All, grid will show lables for all the bands.
      Me.UltraGrid1.DisplayLayout.GroupByBox.ShowBandLabels = ShowBandLabels.All

      ' Configure the look of the band labels.
      Me.UltraGrid1.DisplayLayout.GroupByBox.BandLabelBorderStyle = UIElementBorderStyle.Solid
      Me.UltraGrid1.DisplayLayout.GroupByBox.BandLabelAppearance.BackColor = Color.DarkBlue
      Me.UltraGrid1.DisplayLayout.GroupByBox.BandLabelAppearance.ForeColor = Color.LightYellow

      ' Configure the way button connectors look
      Me.UltraGrid1.DisplayLayout.GroupByBox.ButtonConnectorStyle = UIElementBorderStyle.Dotted
      Me.UltraGrid1.DisplayLayout.GroupByBox.ButtonConnectorColor = Color.Maroon

  End Sub
C#Copy Code
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

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

	// Set the view style to OutlookGroupBy. Without it, group by box won't
	// show up.
	this.ultraGrid1.DisplayLayout.ViewStyleBand = ViewStyleBand.OutlookGroupBy;

	// Set the group-by-box style to Compact to save space.
	this.ultraGrid1.DisplayLayout.GroupByBox.Style = GroupByBoxStyle.Compact;

	// Set the appearance of the group-by-box.
	this.ultraGrid1.DisplayLayout.GroupByBox.Appearance.BackColor = Color.White;

	// Set the group-by-box prompt. This text shows up in the group-by-box when
	// there are no group-by columns.
	this.ultraGrid1.DisplayLayout.GroupByBox.Prompt = "Drag and drop a column to group by that column.";

	// Set the back color and fore color of the prompt area.
	//this.ultraGrid1.DisplayLayout.GroupByBox.PromptAppearance.BackColor = Color.LightGray;
	this.ultraGrid1.DisplayLayout.GroupByBox.PromptAppearance.ForeColor = Color.Maroon;

	// Set the border style to InsetSoft.
	this.ultraGrid1.DisplayLayout.GroupByBox.BorderStyle = UIElementBorderStyle.InsetSoft;
	
	// Configure the buttons associated with grouped-by columns. When a column
	// is dragged and dropped in the group-by-box, the rows get grouped by the
	// column and the column becomes a group-by column.
	//
	this.ultraGrid1.DisplayLayout.GroupByBox.ButtonBorderStyle = UIElementBorderStyle.RaisedSoft;

	// Change the which band labels get shown in the group-by-box. By setting it to
	// All, grid will show lables for all the bands.
	this.ultraGrid1.DisplayLayout.GroupByBox.ShowBandLabels = ShowBandLabels.All;
	
	// Configure the look of the band labels.
	this.ultraGrid1.DisplayLayout.GroupByBox.BandLabelBorderStyle = UIElementBorderStyle.Solid;
	this.ultraGrid1.DisplayLayout.GroupByBox.BandLabelAppearance.BackColor = Color.DarkBlue;
	this.ultraGrid1.DisplayLayout.GroupByBox.BandLabelAppearance.ForeColor = Color.LightYellow;
	
	// Configure the way button connectors look
	this.ultraGrid1.DisplayLayout.GroupByBox.ButtonConnectorStyle = UIElementBorderStyle.Dotted;
	this.ultraGrid1.DisplayLayout.GroupByBox.ButtonConnectorColor = Color.Maroon;

}

Remarks

This property returns a reference to a GroupByBox object that can be used to set properties of, and invoke methods on, a GroupBy box. You can use this reference to access any of the GroupBy box's properties or methods.

See Also