Caption プロパティ (HeaderBase)

ヘッダーのキャプション テキストを返すまたは設定します。

シンタックス

Visual Basic

'宣言
 
Public Property Caption As String

C#

public string Caption {get; set;}

解説

Caption プロパティはオブジェクトに表示されるテキストを決定するために使用されます。通常、Caption によって指定されたテキストは静的です (ユーザーによって編集できません)。編集可能なテキストは Value オブジェクトのプロパティによって通常指定されます。

Caption が null またはゼロ長の文字列に設定されると、プロパティはオブジェクトのデフォルト テキストを返します (Header に関連付けられたオブジェクトの Key)。

使用例

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;

}