GroupHeaderLines Property

Returns or sets the number of lines of text to display for groups headers.

Syntax

Visual Basic

'Declaration
 
Public Property GroupHeaderLines As Integer

C#

public int GroupHeaderLines {get; set;}

Remarks

The GroupHeaderLines property determines how many lines of text can appear inside of a group header. Setting the value of this property will change the height of the group headers to accommodate the specified number of lines, whether or not any group header actually contains enough text to fill multiple lines. The minimum value for this property is 1.

Example

Following code illustrates how one can use ColHeaderLines and GroupHeaderLines properties to show multiline captions in the group and column headers.

Visual Basic

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

  Private Sub Button26_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button26.Click

      Dim band As UltraGridBand = Me.ultraGrid1.DisplayLayout.Bands(0)

      ' Set a column's and group's headers' captions to a multi-line text.
      band.Columns(0).Header.Caption = "Line 1" & vbCrLf & "Line 2"

      ' Assuming you have added groups to the band, set first group's header's Caption 
      ' to a multiline text.
      band.Groups(0).Header.Caption = "Multiline" & vbCrLf & "Group Header"

      ' To accomodate the multiline captions, set the ColHeaderLines and 
      ' GroupHeaderLines to 2.
      band.ColHeaderLines = 2
      band.GroupHeaderLines = 2

  End Sub

C#

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

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

	UltraGridBand band = this.ultraGrid1.DisplayLayout.Bands[0];
 	
	// Set a column's and group's headers' captions to a multi-line text.
	band.Columns[0].Header.Caption = "Line 1\nLine 2";
	
	// Assuming you have added groups to the band, set first group's header's Caption 
	// to a multiline text.
	band.Groups[0].Header.Caption = "Multiline\nGroup Header";
 			
	// To accomodate the multiline captions, set the ColHeaderLines and 
	// GroupHeaderLines to 2.
	band.ColHeaderLines = 2;
	band.GroupHeaderLines = 2;

}

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