Description プロパティ (UltraGridRow)

説明として表示されるテキストを設定します。

シンタックス

Visual Basic

'宣言
 
Public Overridable Property Description As String

C#

public virtual string Description {get; set;}

解説

Description プロパティは、行の AutoPreview 領域に表示されるテキストを決定します。バンドの AutoPreviewField プロパティが有効なフィールドまたは列名に設定されている場合、このプロパティは読み取り専用になります。

次のサンプルコードは UltraGrid.InitializeLayout イベントで行のプレビューを有効にし、UltraGrid.InitializeRow イベントで行の説明テキストを設定します。

C#:

          private void ultraGrid1_InitializeLayout(object sender, Infragistics.Win.UltraWinGrid.InitializeLayoutEventArgs e)
          {
          // Enable the row previews.
          //
          this.ultraGrid1.DisplayLayout.Bands[0].AutoPreviewEnabled = true;
          }

          private void ultraGrid1_InitializeRow(object sender, Infragistics.Win.UltraWinGrid.InitializeRowEventArgs e)
          {
          Infragistics.Win.UltraWinGrid.UltraGridBand band;
          band = this.ultraGrid1.DisplayLayout.Bands[0];

          // Check for the row being from the same band.
          //
          if ( e.Row.Band == band )
          {
          // Create a custom description that we want shown in the row's
          // row preview area.
          //
          System.Text.StringBuilder description = new System.Text.StringBuilder( );

          description.Append( e.Row.GetCellText( band.Columns["ContactName"] ) );
          description.Append( "\n" );
          description.Append( e.Row.GetCellText( band.Columns["City"] ) );
          description.Append( ", " );
          description.Append( e.Row.GetCellText( band.Columns["Country"] ) );

          // Set the row's Description to our custom description text.
          //
          e.Row.Description = description.ToString( );
          }
          }
        

使用例

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid
Imports System.Diagnostics

   Private Sub UltraGrid1_InitializeRow(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.InitializeRowEventArgs) Handles ultraGrid1.InitializeRow

       ' ReInitialize indicates whether the row is being initialized for the first time
       ' or it's being re-initialized.
       If e.ReInitialize Then
           Debug.WriteLine("A row is being re-initilaized.")
       Else
           Debug.WriteLine("A row is being initilaized.")
       End If

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

       ' Check to see if the row is from band 0.
       '
       If e.Row.Band Is Me.ultraGrid1.DisplayLayout.Bands(0) Then
           ' Create a custom description that we want shown in the row's
           ' row preview area.
           Dim description As System.Text.StringBuilder = New System.Text.StringBuilder()

           description.Append(e.Row.GetCellText(band.Columns("ContactName")))
           description.Append(vbCrLf)
           description.Append(e.Row.GetCellText(band.Columns("City")))
           description.Append(", ")
           description.Append(e.Row.GetCellText(band.Columns("Country")))

           ' Set the row's Description to our custom description text.
           e.Row.Description = description.ToString()
       End If

   End Sub

C#

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

private void ultraGrid1_InitializeRow(object sender, Infragistics.Win.UltraWinGrid.InitializeRowEventArgs e)
{

	// ReInitialize indicates whether the row is being initialized for the first time
	// or it's being re-initialized.
	if ( e.ReInitialize )
		Debug.WriteLine( "A row is being re-initilaized." );
	else
		Debug.WriteLine( "A row is being initilaized." );

	UltraGridBand band = this.ultraGrid1.DisplayLayout.Bands[0];
	 
	// Check to see if the row is from band 0.
	//
	if ( e.Row.Band == this.ultraGrid1.DisplayLayout.Bands[0] )
	{
		// Create a custom description that we want shown in the row's
		// row preview area.
		System.Text.StringBuilder description = new System.Text.StringBuilder( );
	 
		description.Append( e.Row.GetCellText( band.Columns["ContactName"] ) );
		description.Append( "\n" );
		description.Append( e.Row.GetCellText( band.Columns["City"] ) );
		description.Append( ", " );
		description.Append( e.Row.GetCellText( band.Columns["Country"] ) );
	 
		// Set the row's Description to our custom description text.
		e.Row.Description = description.ToString( );
	}

}