Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

AutoPreviewEnabled Property (UltraGridBand)

Returns or sets a value that determines whether the AutoPreview area will be displayed.
Syntax
'Declaration
 
Public Property AutoPreviewEnabled As Boolean
public bool AutoPreviewEnabled {get; set;}
Remarks

The AutoPreview area appears under a row and provides a way to display multiple lines of text associated with that row. You can specify how many lines of text should be displayed, and choose to either display the value from a cell in the row or a custom text string that you specify. One common use might be to display the contents of a memo field that initially appears off-screen when the grid is loaded.

The AutoPreviewEnabled property determines whether the AutoPreview area can be displayed for rows in the specified band. Once AutoPreview has been enabled, it can be displayed for any row by setting the UltraGridRow object's AutoPreviewHidden property to False.

The Description property of the row determines the text to be displayed in the AutoPreview area. Description can be automatically set using the field in the row specified by the AutoPreviewField property, or it can be explicitly set through code (for example, in the InitializeRow event handler).

Example
Following code shows how one can enable and customize the Row Auto Preview functionality.

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

  Private Sub Button25_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button25.Click

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

      ' Set the AutoPreviewEnabled to enable row previews.
      band.AutoPreviewEnabled = True

      ' Set the AutoPrevieField to the field contents of which will be  displayed
      ' in the row preview.
      band.AutoPreviewField = "Address"

      ' Indent the text in row previews by 5 pixels
      band.AutoPreviewIndentation = 5

      ' Allow the row previews to display up to 4 lines of text if the text is 
      ' multiline.
      band.AutoPreviewMaxLines = 4

      ' Change how the row preview will look by setting RowPreviewAppearance 
      ' off the override.
      band.Override.RowPreviewAppearance.BackColor = Color.DarkBlue
      band.Override.RowPreviewAppearance.ForeColor = Color.LightYellow

      ' You can set the row preview appearance on per row basis overriding the
      ' settings on the Override.RowPreviewAppearance.
      Me.UltraGrid1.Rows(0).PreviewAppearance.BackColor = Color.Red

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

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

	UltraGridBand band = this.ultraGrid1.DisplayLayout.Bands[0];
	 
	// Set the AutoPreviewEnabled to enable row previews.
	band.AutoPreviewEnabled = true;	
	 
	// Set the AutoPrevieField to the field contents of which will be  displayed
	// in the row preview.
	band.AutoPreviewField = "Address";
	 
	// Indent the text in row previes by 5 pixels
	band.AutoPreviewIndentation = 5;

	// Allow the row previews to display upto 4 lines of text if the text is 
	// multiline.
	band.AutoPreviewMaxLines = 4;
	 
	// Change how the row preview will look by setting RowPreviewAppearance 
	// off the override.
	band.Override.RowPreviewAppearance.BackColor = Color.DarkBlue;
	band.Override.RowPreviewAppearance.ForeColor = Color.LightYellow;

	// You can set the row preview appearance on per row basis overrideing the
	// settings on the Override.RowPreviewAppearance.
	this.ultraGrid1.Rows[0].PreviewAppearance.BackColor = Color.Red;

}
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

See Also