Version

SummaryCalculator Class Members

The following tables list the members exposed by SummaryCalculator.

Public Properties
 NameDescription
Public Propertystatic (Shared in Visual Basic)AverageReturns a static instance of AverageSummaryCalculator for performing average summary calculation.  
Public Propertystatic (Shared in Visual Basic)CountReturns a static instance of AverageSummaryCalculator for performing count summary calculation.  
Public PropertyDescriptionDescription of the summary calculator.  
Public PropertyDisplayNameReturns the display name of the summary calculator. This will be displayed in the UI.  
Public PropertyImageImage for the summary calculator selection UI.  
Public PropertyIsCalculationAffectedBySortIndicates whether the calculation is affected by the order in which data is aggregated. This is used to determine whether the calculation needs to be re-evaluated when the records are sorted.  
Public Propertystatic (Shared in Visual Basic)MaximumReturns a static instance of AverageSummaryCalculator for performing count summary calculation.  
Public Propertystatic (Shared in Visual Basic)MinimumReturns a static instance of AverageSummaryCalculator for performing count summary calculation.  
Public PropertyNameReturns the name of the summary calculator. This identifies the summary calculator.  
Public Propertystatic (Shared in Visual Basic)RegisteredCalculatorsReturns registered summary calculators.  
Public Propertystatic (Shared in Visual Basic)SumReturns a static instance of SumSummaryCalculator for performing sum summary calculation.  
Public Methods
 NameDescription
Public MethodAggregateProcesses individual piece of data value.  
Public MethodApplyDefaultFormatApplies the default format to the specified result and returns a string representation of the summary result as it is to be displayed inside the summary result element.  
Public MethodBeginCalculationStarts summary calculation.  
Public MethodCanProcessDataTypeIndicates whether this summary calculator can use objects of the specified data type as source values for the calculation.  
Public MethodEndCalculationCalled after all the data has been aggregated into the calculation to return the result of the calculation.  
Public Methodstatic (Shared in Visual Basic)RegisterRegisters the specified summary calculator. Existing summary calculator with the same name will be unregistered.  
Public Methodstatic (Shared in Visual Basic)UnRegisterOverloaded. Un-registers a summary calculator.  
See Also