Caption Property (HeaderBase)

Returns or sets the caption text of the header.

Syntax

Visual Basic

'Declaration
 
Public Property Caption As String

C#

public string Caption {get; set;}

Remarks

The Caption property is used to determine the text that will be displayed for an object. Generally, text specified by Caption is static (cannot be edited by the user). Editable text is usually specified by the Value property of an object.

If Caption is set to null or to a zero length string, then the property returns the default text of the object (the Key value of the object associated with the Header.)

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