GroupByRowDescriptionMask Property

A string that determines what text be shown in groupby rows. It can include special substitution strings (e.g. to specify child row count).

Syntax

Visual Basic

'Declaration
 
Public Property GroupByRowDescriptionMask As String

C#

public string GroupByRowDescriptionMask {get; set;}

Remarks

The default string is "[caption] : [value] ([count] [count,items,item,items])".

Note: the replaceable mask items are:

[caption] replaced with the groupby column headers caption.

[value] replaced by the common cell value for this group by.

[count] - the number of visible child rows.

[count,x,y,z] - If count is 0 will substitute the x string, or if count is 1 will substitute the y string otherwise will substitute the z string.

Example

Following code sets the GroupByRowDescriptionMask on the layout's override and a band's override.

Visual Basic

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

  Private Sub Button42_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button42.Click

      ' Set the GroupByRowDescriptionMask on the layout's override.
      Me.UltraGrid1.DisplayLayout.Override.GroupByRowDescriptionMask = "(value): (count) item(s)."

      ' You can override that grid-wide setting for a particular band by setting it on the
      ' override of that band.
      Me.UltraGrid1.DisplayLayout.Bands(0).Override.GroupByRowDescriptionMask = "(value): (count) Customer(s)."

  End Sub

C#

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

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

	// Set the GroupByRowDescriptionMask on the layout's override.
	this.ultraGrid1.DisplayLayout.Override.GroupByRowDescriptionMask = "[value]: [count] item(s).";

	// You can override that grid-wide setting for a particular band by setting it on the
	// override of that band.
	this.ultraGrid1.DisplayLayout.Bands[0].Override.GroupByRowDescriptionMask = "[value]: [count] Customer(s).";

}

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