Version

SummarySettings Class Members

The following tables list the members exposed by SummarySettings.

Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyAppearanceAppearance that will be applied to summaries associated with this SummerySettings object.  
Public PropertyBandReturns the associated band.  
Public PropertyCustomSummaryCalculatorGets or sets the ICustomSummaryCalculator object used for calculating custom summary. This only applies if SummaryType is set to Custom.  
Public PropertyDisplayFormatA substitution string used for formatting the summary. For example: "{0}", "Total = {0}".  
Public PropertyDisplayFormatProviderGets or sets the culture specific information used to determine how values are formatted.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyFormulaSpecifies the formula. UltraGridBase.CalcManager property must be set to a valid instance of Infragistics.Win.CalcEngine.IUltraCalcManager for this property to have any affect. Also the SummaryType property of this summary object must be set to Formula.  
Public PropertyFormulaAbsoluteNameReturns the absolute name of the summary settings that you can use to refer to it in formulas.  
Public PropertyFormulaValueConverterInterface for providing custom logic for converting formula results and the formula source values.  
Public PropertyGroupBySummaryValueAppearanceAppearance that will be applied to summaries in group-by rows associated with this SummerySettings object.  
Public PropertyHasAppearanceReturns true if appearance object for Appearance property has been allocated.  
Public PropertyHasGroupBySummaryValueAppearanceReturns true if appearance object for GroupBySummaryValueAppearance property has been allocated.  
Public PropertyIsExternalReturns True if the SummaryType is External or the Override.UseExternalSummaryCalculator property has been set to True.  
Public PropertyKeyOverridden. Returns or sets a value that uniquely identifies an object in a collection.  
Public PropertyLinesGets or sets the number of text lines summary associated with this summary settings object will have.  
Public PropertyShowCalculatingTextSpecifies whether summaries will display "#Calculating" in when calculating with an UltraCalcManager.  
Public PropertySourceColumnGets or sets the source column. Data from the source column is what gets summarized.  
Public PropertySummaryDisplayAreaSpecifies if and which area(s) the summaries will be displayed in.  
Public PropertySummaryPositionSpecifies where summary footers to display the summary. If its value is UseColumn, then the summary will be displayed under column returned by SummaryPositionColumn property in the summary footers. If its Left or Right they will be displayed in the free-form line of the summary footers.  
Public PropertySummaryPositionColumnColumn under which this property will be displayed. If SummaryPosition is something other than UseColumn, this will be ignored. This column must be from the band that this SummarySettings object is assigned to.  
Public PropertySummaryTypeType of summary to calculate.  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyToolTipTextSpecifies the tooltip to display when the user hovers the mouse over the header.  
Protected Properties
 NameDescription
Protected PropertyKeyLowercaseInterned (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertyPrimaryCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Public Methods
 NameDescription
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodRefreshRecalculates the summaries associated with this SummarySettings object.  
Public MethodResetAppearanceResets Appearance property to its default value.  
Public MethodResetDisplayFormatResets the DisplayFormat to it's default value which is null.  
Public MethodResetDisplayInGroupByResets DisplayInGroupBy property to its default value.  
Public MethodResetFormulaResets Formula property to it's default value of null.  
Public MethodResetGroupBySummaryValueAppearanceResets GroupBySummaryValueAppearance property to its default value.  
Public MethodResetHiddenResets Hidden property to its default value.  
Public MethodResetKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Public MethodResetLinesResets Lines property to it's default value of 1.  
Public MethodResetShowCalculatingTextResets the property to its default value.  
Public MethodResetSummaryDisplayAreaResets the property to its default value.  
Public MethodResetSummaryPositionResets SummaryPosition property to its default value.  
Public MethodResetSummaryPositionColumnResets SummaryPositionColumn property to its default value.  
Public MethodResetToolTipTextResets the property to its default value of false.  
Public MethodShouldSerializeAppearanceReturns true if Appearance property is assigned a non-default value.  
Public MethodShouldSerializeGroupBySummaryValueAppearanceReturns true if GroupBySummaryValueAppearance property is assigned a non-default value.  
Public MethodShouldSerializeHiddenReturns true if Hidden property is assigned a non-default value.  
Public MethodShouldSerializeKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Public MethodShouldSerializeSummaryPositionReturns true if SummaryPosition property is assigned a non-default value.  
Public MethodShouldSerializeSummaryPositionColumnReturns true if SummaryPositionColumn property is assigned a non-default value.  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodToStringReturns an empty string so the property window displays nothing.  
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnAddedToCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected MethodOnDispose (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnRemovedFromCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected MethodOnSubObjectPropChangedOverridden. Called when another sub object that we are listening to notifies us that one of its properties has changed.  
Protected MethodResetInternedKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodShouldSerializeDisplayInGroupByReturns true if DisplayInGroupBy property is assigned a non-default value.  
Protected MethodShouldSerializeFormulaReturns true if formula property is assigned a non-default value.  
Protected MethodShouldSerializeShowCalculatingTextReturns true if the property is set to a non-default value.  
Protected MethodShouldSerializeSummaryDisplayAreaReturns true if SummaryDisplayArea property is set to a non-default value.  
Protected MethodShouldSerializeToolTipTextReturns true if the property has been set to a non-default value of true.  
Public Events
 NameDescription
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
See Also