Namespace: Consultingwerk.SmartComponents.Implementation
Class 
GridColumnAggregates Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartComponents.Implementation.GridColumnAggregates

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddColumnSummaries (UltraGridColumn, character, character, character) Adds the summaries for the aggregate of a grid column
AddColumnSummaries (UltraGridColumn, character, character, character, character) Adds the summaries for the aggregate of a grid column
Infragistics.Win.UltraWinGrid.SummarySettings AddSummary (UltraGridColumn, character, SummaryType, character, character, SummaryDisplayAreas) Adds a summary of a column aggregate to the band of the column
Infragistics.Win.UltraWinGrid.SummarySettings AddSummary (UltraGridColumn, character, SummaryType, character, SummaryDisplayAreas) Adds a summary of a column aggregate to the band of the column
CHARACTER ConvertToCalcFormula (character, UltraGridBand) Translates an aggregate formula of the neutral syntax into an UltraCalc formula of a summary
Infragistics.Win.UltraWinGrid.UltraGridColumn FindColumn (UltraGridBand, character) Returns the column of a band by its key
CHARACTER GetCalcFormula (UltraGridColumn, character) Returns the UltraCalc formula of a formula aggregate and makes sure the grid can evaluate it
CHARACTER GetDisplayFormat (character, character) Returns the .NET composite format of a summary for an aggregate text template
Infragistics.Win.UltraWinGrid.SummaryType GetSummaryType (character) Returns the UltraGrid SummaryType for an aggregate type
LOGICAL IsAggregateSummary (SummarySettings) Returns if a summary was created for a column aggregate
CHARACTER ParseExpression (character, integer, integer, UltraGridBand) Parses a sum or difference of the formula
CHARACTER ParseFactor (character, integer, integer, UltraGridBand) Parses a factor of the formula
CHARACTER ParseFunction (character, integer, integer, UltraGridBand) Parses an aggregate function call of the formula
CHARACTER ParseNumber (character, integer, integer) Parses a number of the formula
CHARACTER ParseTerm (character, integer, integer, UltraGridBand) Parses a product or quotient of the formula
RemoveSummary (UltraGridBand, character) Removes a summary from a band
INTEGER SkipBlanks (character, integer, integer) Returns the position of the next character of the formula that is not a blank

Top Property Summary
Options Name Purpose
CHARACTER FooterSummaryKeyPrefix
CHARACTER FormulaFunctions
CHARACTER GroupSummaryKeyPrefix


Method Detail
Top

AddColumnSummaries (UltraGridColumn, character, character, character)
Purpose: Adds the summaries for the aggregate of a grid column
Notes: Creates a summary in the fixed footer of the grid (visible also
when the rows are grouped) and, when a group template is given,
a second summary displayed in the group-by rows. Summaries created
by an earlier call for the same column are replaced. Without an
aggregate type the summaries of the column are removed.

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The UltraGridColumn to aggregate
pcAggregate CHARACTER
The aggregate type (max, min, sum, count, average)
pcTextTemplate CHARACTER
The text template with the {aggregate} placeholder for the grid footer
pcGroupTextTemplate CHARACTER
The text template with the {aggregate} placeholder for the group-by rows, no group summary when empty
Top

AddColumnSummaries (UltraGridColumn, character, character, character, character)
Purpose: Adds the summaries for the aggregate of a grid column
Notes: Creates a summary in the fixed footer of the grid (visible also
when the rows are grouped) and, when a group template is given,
a second summary displayed in the group-by rows. Summaries created
by an earlier call for the same column are replaced. Without an
aggregate type the summaries of the column are removed.
SCL-6104 - the aggregate type formula requires the formula. An
invalid formula, or a grid without an UltraCalcManager, is logged
and no summary is created - the grid still renders. A
SmartDataBrowser creates its UltraCalcManager when needed.

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The UltraGridColumn to aggregate
pcAggregate CHARACTER
The aggregate type (max, min, sum, count, average, formula)
pcFormula CHARACTER
The formula in the neutral syntax for the aggregate type formula, ignored otherwise
pcTextTemplate CHARACTER
The text template with the {aggregate} placeholder for the grid footer
pcGroupTextTemplate CHARACTER
The text template with the {aggregate} placeholder for the group-by rows, no group summary when empty
Top

Infragistics.Win.UltraWinGrid.SummarySettings AddSummary (UltraGridColumn, character, SummaryType, character, character, SummaryDisplayAreas)
Purpose: Adds a summary of a column aggregate to the band of the column
Notes: Used by AddColumnSummaries and to restore the summaries the
SmartDataBrowser removes while further batches can be loaded
(AggregatesOnlyWhenAllRowsLoaded). The summary is aligned like
the cells of the column. SCL-6104 - a summary of the type Formula
evaluates the UltraCalc formula, the column only positions it.

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The UltraGridColumn to aggregate
pcKey CHARACTER
The key of the summary
poSummaryType Infragistics.Win.UltraWinGrid.SummaryType
The SummaryType
pcCalcFormula CHARACTER
The UltraCalc formula for the SummaryType Formula, ignored otherwise
pcDisplayFormat CHARACTER
The .NET composite format of the summary value
poDisplayArea Infragistics.Win.UltraWinGrid.SummaryDisplayAreas
The SummaryDisplayAreas
Returns Infragistics.Win.UltraWinGrid.SummarySettings
The new SummarySettings
Top

Infragistics.Win.UltraWinGrid.SummarySettings AddSummary (UltraGridColumn, character, SummaryType, character, SummaryDisplayAreas)
Purpose: Adds a summary of a column aggregate to the band of the column
Notes: Used by AddColumnSummaries and to restore the summaries the
SmartDataBrowser removes while further batches can be loaded
(AggregatesOnlyWhenAllRowsLoaded). The summary is aligned like
the cells of the column.

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The UltraGridColumn to aggregate
pcKey CHARACTER
The key of the summary
poSummaryType Infragistics.Win.UltraWinGrid.SummaryType
The SummaryType
pcDisplayFormat CHARACTER
The .NET composite format of the summary value
poDisplayArea Infragistics.Win.UltraWinGrid.SummaryDisplayAreas
The SummaryDisplayAreas
Returns Infragistics.Win.UltraWinGrid.SummarySettings
The new SummarySettings
Top

CHARACTER ConvertToCalcFormula (character, UltraGridBand)
Purpose: Translates an aggregate formula of the neutral syntax into an
UltraCalc formula of a summary
Notes: SCL-6104. The neutral syntax knows the aggregate functions sum,
min, max, count and average over a column of the band (the column
name is matched case-insensitive against the column keys),
numbers with a decimal point, the operators + - * / and
parentheses. Column references are escaped for UltraCalc. Every
division is guarded, so a division by zero yields 0:
sum(MTD4Gross) / sum(MTD1Sale) * 100 becomes
if(sum([MTD1Sale]) = 0, 0, sum([MTD4Gross]) / sum([MTD1Sale])) * 100

Parameters:
pcFormula CHARACTER
The formula in the neutral syntax
poBand Infragistics.Win.UltraWinGrid.UltraGridBand
The UltraGridBand that holds the referenced columns
Returns CHARACTER
The UltraCalc formula
Top

Infragistics.Win.UltraWinGrid.UltraGridColumn FindColumn (UltraGridBand, character)
Purpose: Returns the column of a band by its key
Notes: SCL-6104 - compared case-insensitive

Parameters:
poBand Infragistics.Win.UltraWinGrid.UltraGridBand
The UltraGridBand
pcColumnName CHARACTER
The key of the column
Returns Infragistics.Win.UltraWinGrid.UltraGridColumn
The UltraGridColumn or the unknown value when the band has no such column
Top

CHARACTER GetCalcFormula (UltraGridColumn, character)
Purpose: Returns the UltraCalc formula of a formula aggregate and makes
sure the grid can evaluate it
Notes: SCL-6104. A SmartDataBrowser creates its UltraCalcManager when it
has none. An invalid formula or a grid without UltraCalcManager
is written to the log file.

Parameters:
poColumn Infragistics.Win.UltraWinGrid.UltraGridColumn
The UltraGridColumn the summary is displayed in
pcFormula CHARACTER
The formula in the neutral syntax
Returns CHARACTER
The UltraCalc formula, or the unknown value when no formula summary can be created
Top

CHARACTER GetDisplayFormat (character, character)
Purpose: Returns the .NET composite format of a summary for an aggregate
text template
Notes: The placeholder {aggregate} becomes {0}, or {0:<format>} when the
column has a display format. Other braces of the template are
escaped, so they are displayed literally. An empty template
displays the value only.

Parameters:
pcTextTemplate CHARACTER
The text template with the {aggregate} placeholder
pcColumnFormat CHARACTER
The .NET display format of the column (e.g. #,##0.00), may be empty
Returns CHARACTER
The value for the DisplayFormat property of the SummarySettings
Top

Infragistics.Win.UltraWinGrid.SummaryType GetSummaryType (character)
Purpose: Returns the UltraGrid SummaryType for an aggregate type
Notes: The aggregate types are the values of the Aggregate repository
attribute, compared case-insensitive

Parameters:
pcAggregate CHARACTER
The aggregate type (max, min, sum, count, average, formula)
Returns Infragistics.Win.UltraWinGrid.SummaryType
The SummaryType or the unknown value for an empty or unsupported aggregate type
Top

LOGICAL IsAggregateSummary (SummarySettings)
Purpose: Returns if a summary was created for a column aggregate
Notes: Identified by the key prefixes of the footer and group summaries,
summaries added by the user (AllowRowSummaries) return false

Parameters:
poSummary Infragistics.Win.UltraWinGrid.SummarySettings
The SummarySettings
Returns LOGICAL
Logical value indicating if the summary renders a column aggregate
Top

CHARACTER ParseExpression (character, integer, integer, UltraGridBand)
Purpose: Parses a sum or difference of the formula
Notes: SCL-6104 - expression := term { ("+" | "-") term }

Parameters:
pcFormula CHARACTER
The formula in the neutral syntax
piPosition INTEGER
The current position in the formula, advanced behind the expression
piLength INTEGER
The length of the formula
poBand Infragistics.Win.UltraWinGrid.UltraGridBand
The UltraGridBand that holds the referenced columns
Returns CHARACTER
The UltraCalc formula of the expression
Top

CHARACTER ParseFactor (character, integer, integer, UltraGridBand)
Purpose: Parses a factor of the formula
Notes: SCL-6104 - factor := number | function "(" column ")"
| "(" expression ")" | ("+" | "-") factor

Parameters:
pcFormula CHARACTER
The formula in the neutral syntax
piPosition INTEGER
The current position in the formula, advanced behind the factor
piLength INTEGER
The length of the formula
poBand Infragistics.Win.UltraWinGrid.UltraGridBand
The UltraGridBand that holds the referenced columns
Returns CHARACTER
The UltraCalc formula of the factor
Top

CHARACTER ParseFunction (character, integer, integer, UltraGridBand)
Purpose: Parses an aggregate function call of the formula
Notes: SCL-6104 - function "(" column ")". Everything between the
parentheses is the column name, so column names may contain
characters such as - or %. The column reference is escaped for
UltraCalc.

Parameters:
pcFormula CHARACTER
The formula in the neutral syntax
piPosition INTEGER
The current position in the formula (first letter of the function name), advanced behind the closing parenthesis
piLength INTEGER
The length of the formula
poBand Infragistics.Win.UltraWinGrid.UltraGridBand
The UltraGridBand that holds the referenced columns
Returns CHARACTER
The UltraCalc formula of the function call
Top

CHARACTER ParseNumber (character, integer, integer)
Purpose: Parses a number of the formula
Notes: SCL-6104 - digits with an optional decimal point, a leading
decimal point gets a 0 in front

Parameters:
pcFormula CHARACTER
The formula in the neutral syntax
piPosition INTEGER
The current position in the formula, advanced behind the number
piLength INTEGER
The length of the formula
Returns CHARACTER
The number in the UltraCalc formula
Top

CHARACTER ParseTerm (character, integer, integer, UltraGridBand)
Purpose: Parses a product or quotient of the formula
Notes: SCL-6104 - term := factor { ("*" | "/") factor }. A division is
guarded, so a division by zero yields 0.

Parameters:
pcFormula CHARACTER
The formula in the neutral syntax
piPosition INTEGER
The current position in the formula, advanced behind the term
piLength INTEGER
The length of the formula
poBand Infragistics.Win.UltraWinGrid.UltraGridBand
The UltraGridBand that holds the referenced columns
Returns CHARACTER
The UltraCalc formula of the term
Top

RemoveSummary (UltraGridBand, character)
Purpose: Removes a summary from a band
Notes:

Parameters:
poBand Infragistics.Win.UltraWinGrid.UltraGridBand
The UltraGridBand
pcKey CHARACTER
The key of the summary
Top

INTEGER SkipBlanks (character, integer, integer)
Purpose: Returns the position of the next character of the formula that
is not a blank
Notes: SCL-6104 - blanks, tabs and line breaks are skipped

Parameters:
pcFormula CHARACTER
The formula in the neutral syntax
piPosition INTEGER
The current position in the formula
piLength INTEGER
The length of the formula
Returns INTEGER
The position of the next character that is not a blank, piLength + 1 at the end of the formula


Property Detail
Top

CHARACTER FooterSummaryKeyPrefix

Returns CHARACTER
Top

CHARACTER FormulaFunctions

Returns CHARACTER
Top

CHARACTER GroupSummaryKeyPrefix

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:07:19