Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

GroupingSettings Class Members

The following tables list the members exposed by GroupingSettings.

Public Constructors
 NameDescription
Public ConstructorGroupingSettings ConstructorCreates a new instance of GroupingSettings object  
Public Fields
 NameDescription
Public FieldRemoveBtnImageUrlRemove button image URL  
Public FieldRemoveBtnImageUrlHoveredRemove button hover image URL  
Public FieldRemoveBtnImageUrlPressedRemove button press image URL  
Public Properties
 NameDescription
Public PropertyAscendingImageAltTextAlternate text of the ascending order image.  
Public PropertyAscendingImageUrlA url to the ascending order image that appears in the group by area next to the column header column. If nothing is assigned to the property the image with the name "igg_sortAsc.gif" from current Application Styling images directory is used.  
Public PropertyBottomDragIndicatorCssClassGets/sets the css class used to style the bottom portion of the drop indicator.  
Public PropertyColumnSettingsA collection of type ColumnGroupingSettings.  
Public PropertyDescendingImageAltTextAlternate text of the descending order image.  
Public PropertyDescendingImageUrlA url to the descending order image that appears in the group by area next to the column header column. If nothing is assigned to the property the image with the name "igg_sortDesc.gif" from current Application Styling images directory is used.  
Public PropertyDragMarkupCssClassReturns/sets the css class used to style the DragMarkup. If the default drag markup is used this class will be applied in addition to the styles already applied to the header, if the dragmarkup is replaced only the DragMarkupCssClass will be used.  
Public PropertyEnableCellMergingDefines whether to merge cells in a grouped column  
Public PropertyEnableColumnGroupingDetermines if the column grouping is enabled for the band.  
Public PropertyGroupedBandCssClassThe name of the css class that will be applied to the element representing the band in the grouped by area.  
Public PropertyGroupedColumnLabelCssClassThe name of the css class that will be applied to the clone of the column found in the grouped by area.  
Public PropertyGroupedColumnsA collection of columns by which the data is currently grouped on this band.  
Public PropertyGroupedRowCssClassThe name of the css class that will be applied to the row showing the group.  
Public PropertyGroupedRowTextMaskThe mask for the text of Grouped row. Available tokens: {0} - header of the grouped column, {1} - grouped value, {2} - number of grouped child rows, {3} - number of all data records in the group.  
Public PropertyIndentationFactorFactor by how much to indent the next group row or data rows. Has to be a positive integer. The default is 20.  
Public PropertyInitialRowExpandStateIndicates if the grouped rows are rendered as expanded or collapsed by default.  
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 PropertyMiddleDragIndicatorCssClassGets/sets the css class used to style the middle portion of the drop indicator.  
Public PropertyRemoveButtonThis will be an ImageButton object, when this button is clicked the grouped column to which the button belongs to will be removed from the group columns collection.  
Public PropertyShowBandInGroupByAreaIndicates whether a graphical representation of the band will be shown in the group by area, when one or more columns are grouped.  
Public PropertyShowRemoveButtonBoolean property, which is true by default. Controls whether the RemoveButton will be shown for the grouped column headers, when the mouse is over the header.  
Public PropertyTopDragIndicatorCssClassGets/sets the css class used to style the top portion of the drop indicator.  
Protected Properties
 NameDescription
Protected PropertyAdditionalClientState (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyCollectionData (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
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 PropertyPropCountThis property is used to track the number of properties this object is sending to ClientState. Each derived class overrides this property to indicate the new total of properties. The number consists of the PropCount value of the base class plus the number of ClientState properties utilized by each derived class. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
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 MethodCloneClones the object (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
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 MethodResolveGroupComparerProvides a reference to the group comparer that is currently used off the column's group setting.  
Public MethodToStringReturns string representation of the object.  
Protected Methods
 NameDescription
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 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 MethodLoadClientCollectionsTransactionListOverridden. Reads the TransactionList and repopulates the collections of the control.  
Protected MethodLoadClientObjectsOverridden. Loads the Objects that were sent down to the client, back into the control.  
Protected MethodLoadClientObjectsTransactionListReads the Transaction List and repopulates the objects of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
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 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 MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
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. Serializes the ClientState properties of the object to a JSON stream that will be accessed from the client. The FullAddress property of the Object is also accessed in this process to identify the object being serialized to JSON.  
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 MethodShouldSerializeGroupedColumnsDetermines of the GroupedColumns property should be persisted.  
Protected MethodTrackViewStateOverridden. Overrides base class' method. Enables the view state tracking for the behavior.  
Protected MethodWriteAdditionalClientPropertiesIf an object needs to render additional information that needs to be accessed on the client, this is where they can add this information. Note that each object that they need to render should be prefixed with a Comma because the information is being rendered inside of a javascript array. This method is called by WriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
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)
See Also