Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

GroupByBox Property (UltraGridLayout)

Returns a reference to the GroupByBox object associated wiht the layout. The GroupByBox is used to specify GroupBy rows when the control is in GroupBy mode. GroupByBox
Syntax
'Declaration
 
Public ReadOnly Property GroupByBox As GroupByBox
public GroupByBox GroupByBox {get;}
Remarks

The GroupBy Box is an interface element that gives you a way to dynamically group row data for display. When the GroupBy Box is visible, you can drag column headers into it using the mouse. The data will then be grouped according to the field you have specified. The grid creates a series of GroupBy rows whihc serve to aggregate data that has a common field value. You can then expand or collapse the GroupBy row to display or hide the data for a particular value.

For example, suppose you have a band in the grid that displays address information, including a field for City. If you drag the header of the City column into the GroupBy box, the grid will display a GroupBy row for every city that occurs in the rows of the band. You can expand the GroupBy row for a particular city to see all the data that relates to that city (i.e. all the data that has the name of the chosen city specified in its City field.)

The GroupBy Box object supports properties that give you control over the look of the GroupBy Box interface element (including an Appearance property.)

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.

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
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;

}
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

See Also