Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

SummaryFooterCaption Property (UltraGridBand)

Gets or sets summary footer caption substitution string.
Syntax
'Declaration
 
Public Property SummaryFooterCaption As String
public string SummaryFooterCaption {get; set;}
Remarks

You can specify what gets shown in the summary footers' captions by setting this property to a substitution string. The format of the substition string is as follows:

Any column names surrounded by square brakets will be substituted by that column's value. The column must be from the parent band. There are three tokens with special meaning:

[BANDHEADER]
, 
[SCROLLTIPFIELD]
and 
[GROUPBYROWVALUE]
. 
[BANDHEADER]
will be substituted by the band header's caption Header. 
[SCROLLTIPFIELD]
will be substitued by the value of the column associated with ScrollTipField in the parent band. 
GROUPBYROWVALUE
will be substituted by the parent group-by row's value. This only makes sense for summary footers of rows that belong to a group-by row.

NOTE: Columns you specify for substitution must be from the parent band. ScrollTipField used is also from parent band. If there is no parent band, they will not be substituted with anything and left as they are.

Default value for the root rows is

"Grand Summaries"
and for child rows it's 
"Summaries for [BANDHEADER]: [SCROLLTIPFIELD]"
.

You can hide the summary footer caption by using the UltraGridOverride.SummaryFooterCaptionVisible property. Also the summary caption can be controlled on an individual summary footer by setting the SummaryValuesCollection.SummaryFooterCaption property. SummaryValuesCollection can be accessed using RowsCollection.SummaryValues property.

Example
Following code sets the appearance related properties for summaries.

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

  Private Sub Button14_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button14.Click

      ' Set the appearance of the summary footer area.
      Me.ultraGrid1.DisplayLayout.Override.SummaryFooterAppearance.BackColor = Color.White
      Me.ultraGrid1.DisplayLayout.Override.SummaryFooterAppearance.ForeColor = Color.Black

      ' Set the border style of the summary footer.
      Me.ultraGrid1.DisplayLayout.Override.BorderStyleSummaryFooter = UIElementBorderStyle.Solid

      ' Set the appearance for the caption on top of the summary area.
      Me.ultraGrid1.DisplayLayout.Override.SummaryFooterCaptionVisible = DefaultableBoolean.True
      Me.ultraGrid1.DisplayLayout.Override.SummaryFooterCaptionAppearance.BackColor = Color.DarkBlue
      Me.ultraGrid1.DisplayLayout.Override.SummaryFooterCaptionAppearance.BackColor = Color.LightYellow

      ' Set the text that shows up in the caption of the summary footer.
      Me.ultraGrid1.DisplayLayout.Bands(0).SummaryFooterCaption = "Summaries for customers"

      ' Set the border style for the summary footer caption.
      Me.ultraGrid1.DisplayLayout.Override.BorderStyleSummaryFooterCaption = UIElementBorderStyle.Solid

      ' Set the appearance of individual summaries inside the summary footer
      Me.ultraGrid1.DisplayLayout.Override.SummaryValueAppearance.TextHAlign = HAlign.Right
      Me.ultraGrid1.DisplayLayout.Override.SummaryValueAppearance.BackColor = Color.White
      Me.ultraGrid1.DisplayLayout.Override.SummaryValueAppearance.ForeColor = Color.Black

      ' Set the border style for summaries in the footer.
      Me.ultraGrid1.DisplayLayout.Override.BorderStyleSummaryValue = UIElementBorderStyle.Solid

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

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

	// Set the appearance of the summary footer area.
	this.ultraGrid1.DisplayLayout.Override.SummaryFooterAppearance.BackColor = Color.White;
	this.ultraGrid1.DisplayLayout.Override.SummaryFooterAppearance.ForeColor = Color.Black;

	// Set the border style of the summary footer.
	this.ultraGrid1.DisplayLayout.Override.BorderStyleSummaryFooter = UIElementBorderStyle.Solid;

	// Set the appearance for the caption on top of the summary area.
	this.ultraGrid1.DisplayLayout.Override.SummaryFooterCaptionVisible = DefaultableBoolean.True;
	this.ultraGrid1.DisplayLayout.Override.SummaryFooterCaptionAppearance.BackColor = Color.DarkBlue;
	this.ultraGrid1.DisplayLayout.Override.SummaryFooterCaptionAppearance.BackColor = Color.LightYellow;

	// Set the text that shows up in the caption of the summary footer.
	this.ultraGrid1.DisplayLayout.Bands[0].SummaryFooterCaption = "Summaries for customers";

	// Set the border style for the summary footer caption.
	this.ultraGrid1.DisplayLayout.Override.BorderStyleSummaryFooterCaption = UIElementBorderStyle.Solid;

	// Set the appearance of individual summaries inside the summary footer
	this.ultraGrid1.DisplayLayout.Override.SummaryValueAppearance.TextHAlign = HAlign.Right;
	this.ultraGrid1.DisplayLayout.Override.SummaryValueAppearance.BackColor = Color.White;
	this.ultraGrid1.DisplayLayout.Override.SummaryValueAppearance.ForeColor = Color.Black;			

	// Set the border style for summaries in the footer.
	this.ultraGrid1.DisplayLayout.Override.BorderStyleSummaryValue = UIElementBorderStyle.Solid;

}
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