Version

SummaryRow Class Members

The following tables list the members exposed by SummaryRow.

Public Constructors
 NameDescription
Public ConstructorSummaryRow ConstructorDefault constructor for the SummaryRow Behavior  
Public Properties
 NameDescription
Public PropertyAnimationDurationMsThe duration of the animation that the summary dropdown will play while its displaying or hiding in milliseconds  
Public PropertyAnimationEnabledDetermines whether the summary dropdown will play an animation while it is displaying or hiding  
Public PropertyAnimationTypeThe type of animation that the summary dropdown will play when it is displaying or hiding.  
Public PropertyColumnSettingsHolds the column settings for the SummaryRow behavior.  
Public PropertyColumnSummariesA collection of columns that will have summaries calculated for them. Only one entry per column is allowed.  
Public PropertyCompactRenderingSpecifies how compact the summaries are rendered. On indicates that the summaries may be rendered compactly, even mixing different summaries on the same line. Off ensures that each summary type is occupying a separate line. Auto will use Off if the maximum number of visible summaries is one or less and On otherwise.  
Public PropertyEmptyFooterTextFiller for an empty summary . The deafult value is "--".  
Public PropertyEnabledOverridden. Ovverriden property. Enable the behvaior in the grid.  
Public PropertyEnableInheritanceThis property will have an affect only for WebHierarchicalDataGrid and when set to true will enable the behavior for child bands.  
Public PropertyEnableSummariesFilterIf the property is set to True then summaries will calculate based on the data that has not been filtered out by the filtering conditions applied through the grid's Filtering behavior. If the property is set to False then the summaries will be calculated on the whole data no matter if it is filtered out or not.  
Public PropertyFormatStringThis is the format string that is applied to all summaries' text in the footer. The default is "{0} = {1}" where {0} is the summary name and {1} is the value. Beware that using a formatting specific to a particular type here can cause an exception when other types use this formatting. This can be overriden on a column setting or a summary setting.  
Public PropertyGridA reference to the grid the behavior belongs to. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyHasCalculateCustomSummaryHandledIndicates if the CalculateCustomSummary event is handled.  
Public PropertyHasCalculateNormalSummaryHandledIndicates if the CalculateCustomSummary event is handled.  
Public PropertyHasSummaryCalculatedHandledIndicates if the SummaryCalculated event is handled.  
Public PropertyIndexIndex of the behavior inside of the behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyIsEmptyChecks if ViewState has any property with not a default value. This property should be overriden by extended class when additional subobjects are supported. IsEmpty will then check each subobject and return a value based on the check of those objects plus itself. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public PropertyNameOverridden. Holds name of the behavior. It's "SummaryRow" for the summaries behavior.  
Public PropertyOwnerCollectionA reference to the grid behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyShowSummariesButtonsBoolean property, which determines if the summary buttons for the summary row are shown next to the header caption.

True - the buttons are shown, this is the default

False - the buttons are not shown and summaries can only be add programmatically.

 
Public PropertySummariesCssClassCSS class for the summaries cells (the TH elements that display the summary value).  
Public PropertySummaryButtonThe button object that will be displayed in the grid's column header for showing the summary drop down.  
Public PropertySummaryDropdownZIndexSets/Gets the Z-Index of the summary dropdown element.  
Public PropertySummaryRowClientEventsHolds client side event definitions for the summary row behavior.  
Protected Properties
 NameDescription
Protected PropertyAdditionalClientState (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyCollectionData (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyControlRunBotReturns reference to the Grid's runbot (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected PropertyDelayLoadingClientCollectionsCustomizes the client collections loading. If true the collections will be loaded after view state has been loaded. If false the collections will be loaded in RunBot.HandleOnInit. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyIsTrackingViewStateThis method returns a boolean value which indicates whether ViewState is being tracked for the object. Once viewstate is being tracked, all property changes are roundtripped from server to client and back within the ViewState hidden field. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyPropCountOverridden. The number of properties for SummaryRow  
Protected PropertyRequiresDataBindingOverridden. Indicates whether the behavior is data binding related.  
Protected PropertyTransactionLists (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyViewStateProperty to return the ViewState bag for the object. If none exist, then one is created. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public Methods
 NameDescription
Public MethodCloneOverridden. Creates a clone of the object  
Public MethodCopyToOverridden. Copies properties from the current object into the passed in object  
Public MethodIsDirtyOverloaded. This method determines if the property with the specified Id within the ViewState bag is dirty and needs to be sent to and from the client. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public MethodToStringReturns string representation of the object. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected Methods
 NameDescription
Protected MethodCreateClientEventsOverridden. Place holder for the behavior's client events.  
Protected MethodCreateNewInstanceCreates a new instance of the current type using the default constructor. Derived classes may override the method if there is no parameterless constructor or any other custom logic applies. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodFlushEmpties the positional and occasional property stringBuffers and converts them to a string representation that can be written to the response stream. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodGetClientPropertiesArray (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodGetRoleCountOverridden. Overrides base class' method. Returns number of AppStyling roles supported by the summaries.  
Protected MethodGetRoleInfoOverridden. Overrides base class' method. Gets reference to the summaries role info by its index.  
Protected MethodLoadAdditionalClientStateThis method is called when additional information is passed from the client, via the _saveAdditionalClientState javascript method (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientCollectionsOverridden. Loads the Collections that were sent down to the client, back into the control.  
Protected MethodLoadClientCollectionsTransactionListReads the TransactionList and repopulates the collections of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsOverridden. Loads the Objects that were sent down to the client, back into the control.  
Protected MethodLoadClientObjectsTransactionListOverridden. Reads the Transaction List and repopulates the objects of the control.  
Protected MethodLoadClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientPropsTransactionListReads the Transaction List and repopulates the properties of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateThis method takes the state from the client and loads the control's Properties, Objects, and Collections, that were sent down to the client on the last post. It also stores the TransactionLists for the Properties, Objects, and Collections. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateFromViewStateChecks to see if ClientState was saved into Viewstate, if so, then it loads. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadCollectionsStateFromViewStateLoads the saved into view state client collections and deserializes the string as it came from the client side. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperty (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertiesLoads client state properties from the client (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertyLoad positional property at index (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadTransactionListLoads the transaction list. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadViewStateOverridden. Load data modified at run time.  
Protected MethodMultiInstancesAllowedIndicates whether functionality can be added into the functionality collection multiple times. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodOnActionOverridden. Overrides base class' method. Handles processing of adjusting summaries.  
Protected MethodOnCalculateCustomSummaryFires the CalculateCustomSummary event.  
Protected MethodOnCalculateNormalSummaryFires the CalculateSummary event.  
Protected MethodOnCallbackCreatedOverridden. Overrides base class' method. Called when an asynchronous request is initiated by the sorting - a column is being sorted and the sorting is in the AJAX mode.  
Protected MethodOnCallbackRenderCalled when the behavior needs to returns its response to an asynchrohous request. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodOnItemCommandCalled for every behavior to give it a chance to handle the command bubbled from inside of the child controls collection of the grid. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodOnLoadOverridden. Overrides base behavior's GridBehavior.OnLoad method. Hooks up all of the internal events from inside of the method.  
Protected MethodOnPartialClearCalled when the behaviors collection is being partially cleared. This is where the behavior will have to remove any controls it added to the grid's controls collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodOnPropertyChangeOverloaded. Virtual method that is called whenever a server state property within the object has been changed. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodOnSummaryCalculatedFires the SummaryCalculated event.  
Protected MethodOnUnloadOverridden. Overrides base class' method. Unhooks all of the internal event handlers previously hooked by the summaries.  
Protected MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodRegisterScriptsOverridden. Overrides base class' method. Called by the framework for the summaries to provide its script references.  
Protected MethodResetClientStateResets the positional and occasional property stringBuffers to initial empty values. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientCollectionsOverridden. Saves all Collections that should go to the client into a javascript array.  
Protected MethodSaveClientObjectsOverridden. Saves all objects that should go to the client into a javascript array.  
Protected MethodSaveClientPropertiesOverloaded. Overridden. Saves any additional properties to be brought to the client.  
Protected MethodSaveClientStateToViewStateIf the control is not visible, we don't want to loose our ClientState during the next postback, so lets store it in ViewState. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveCollectionsStateToViewStateSaves the client collections state as string into the view state. This way we can skip the expensive serialization on the client side and not send them at all. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveViewStateOverridden. Save data modified at run time.  
Protected MethodShouldSerializeColumnSettingsDetermines if the ColumnSettings should be serialized.  
Protected MethodShouldSerializeColumnSummariesDetermines if ColumnSummaries should be persisted  
Protected MethodTrackViewStateOverridden. Overrides base class' method. Enables the view state tracking for the behavior.  
Protected MethodWriteAdditionalClientPropertiesCalled by the framework for the behavior to add its additional client roperties. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodWriteClientCollections (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientObjects (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientOnlyPropertyStores the property in hashtable, that will be rendered down to the client. Client only properties only get sent down to the client, they do not get sent back to the server. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientStateResponsible for rendering javascript array of all client properties, events, objects and collections Calls helper methods to render each in turn. That method is called to render parameter for initialization (constructor) java-script function. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWritePositionalPropertyWrites the passed in property value at the current position of the ClientState serialization. The property is serialized to the positional properties string of the ClientState string. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public Events
 NameDescription
Public EventCalculateCustomSummaryEvent that is fired whenever each custom summary needs to be calculated.  
Public EventCalculateSummaryEvent that is fired whenever each normal summary type needs to be calculated because the grid is doing custom binding  
Public EventSummaryCalculatedEvent that is fired whenever a stadard summary is calculated (any summary which is not a custom summary).  
See Also