Version

GridGroupBy Class Properties

For a list of all members of this type, see GridGroupBy members.

Public Properties
 NameDescription
Public PropertyClientEventsSet implementations of client events raised by a widget.

Event handler assumes 2 parameters: 1st parameter has name "evt" and 2nd parameter has name "ui". To get information about member variables available for "ui" parameter, please consult documentation of a widget and its events.

Examples:

1. Full implementation:

new Dictionary<string, string> { { "dropDownOpening", "function(evt,ui){alert('drop:'+ui.owner);}" } }

2. Content of inline function:

new Dictionary<string, string> { { "dropDownOpening", "alert('drop:'+ui.owner);" } }

3. Name of global function:

new Dictionary<string, string> { { "dropDownOpening", "nameOfGlobalFunction" } } Note:

Instead of explicit key-strings, which represent name of event exposed by a widget, the event-constants defined by a particular control can be used.

Example:

new Dictionary<string, string> { { ComboClientEvents.DropDownOpening, "nameOfGlobalFunction" } } (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public PropertyCollapseTooltipcollapse tooltip  
Public PropertyColumnSettingslist of column settings  
Public PropertyDefaultSortingDirectiondefault sort order - asc or desc  
Public PropertyDialogWidgetName of the dialog widget to be used. It should inherit from $.ui.igGridModalDialog.  
Public PropertyEmptyGroupByAreaContentspecifies the string to show to inform the end user that they can drag a column header  
Public PropertyEmptyGroupByAreaContentSelectColumnsText of link(on click shows modal dialog with columns which could be group/ungroup by) that will be shown in the GroupBy area when there are no grouped columns  
Public PropertyEmptyGroupByAreaContentSelectColumnsCaptionSpecifies caption for button which opens groupby dialog  
Public PropertyExpandTooltipexpand tooltip  
Public PropertyExpansionIndicatorVisibilityspecifies whether to show a +/- sign for the grouped rows  
Public PropertyFeatureChooserTextSpecifies the text in feature chooser  
Public PropertyFeatureChooserTextHideSpecifies hide text in feature chooser  
Public PropertyGroupByAreaVisibilityspecifies where the groupBy row will be rendered relative to the grid contents (data)  
Public PropertyGroupByDialogContainmentControls containment behavior for the groupby dialog.  
Public PropertyGroupByLabelWidthwidth of the group by labels when they are dropped onto the group by area by default they take the width of the columns  
Public PropertyGroupByUrlKeyGroupBy URL key encoded in the GET request (when grouping is configured remotely)  
Public PropertyGroupByUrlKeyAscValueascending value name in the URL params . ?groupby(col1)=GroupByUrlKeyAscValue  
Public PropertyGroupByUrlKeyDescValuedescending value name in the url params . Example ?groupby(col1)=GroupByUrlKeyDescValue  
Public PropertyGroupedRowTextTemplatetemplate for the group row text  
Public PropertyGroupSummariesGroup summaries that specify the default summaries for each column  
Public PropertyGroupSummariesPositionSpecifies the group summaries row postion inside each group.  
Public PropertyIndentationdefault indentation for the grouped rows  
Public PropertyInheritOverridden.   
Public PropertyInitialExpandinitial expansion of grouped rows  
Public PropertyLabelDragHelperOpacityopacity of the label (column header) while it's being dragged (and before it's dropped)  
Public PropertyLanguageGets/sets Language the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyLocalea list of configurable and localized labels that are used for the predefined GroupBy localizable strings  
Public PropertyModalDialogAnimationDurationSpecifies time in milliseconds for animation duration to show/hide modal dialog  
Public PropertyModalDialogButtonApplyTextSpecifies text of button which apply changes in modal dialog  
Public PropertyModalDialogButtonCancelTextSpecifies text of button which cancel changes in modal dialog  
Public PropertyModalDialogCaptionButtonAscSpecifies caption for each ascending sorted column in groupby dialog  
Public PropertyModalDialogCaptionButtonDescSpecifies caption for each descending sorted column in groupby dialog  
Public PropertyModalDialogCaptionButtonUngroupSpecifies caption button ungroup in groupby dialog  
Public PropertyModalDialogCaptionTextSpecifies caption text for groupby dialog  
Public PropertyModalDialogClearAllButtonLabelSpecifies label for clear all button in groupby dialog  
Public PropertyModalDialogDropDownAreaWidthSpecifies height of layouts dropdown in groupby dialog  
Public PropertyModalDialogDropDownButtonCaptionSpecifies caption of layouts dropdown button in groupby dialog  
Public PropertyModalDialogDropDownLabelSpecifies label for layouts dropdown in groupby dialog  
Public PropertyModalDialogDropDownWidthSpecifies width of layouts dropdown in groupby dialog  
Public PropertyModalDialogGroupByButtonTextspecifies the text of GroupBy button in the groupby dialog  
Public PropertyModalDialogGroupByOnClickSpecifies whether on click in groupby dialog to be immediately grouped/ungrouped columns. When it is false then it is shown Apply button in the groupby dialog  
Public PropertyModalDialogHeightSpecifies height of groupby dialog  
Public PropertyModalDialogRootLevelHierarchicalGridSpecifies name of the root layout which is shown layouts tree dialog  
Public PropertyModalDialogWidthSpecifies width of groupby dialog  
Public PropertyNamename of the feature, need to be set by every feature (Inherited from Infragistics.Web.Mvc.GridFeature)
Public PropertyPagingModepaging mode - when there is at least one grouped columns and paging is applied specifies which records should be included in page processing. Available options are "allRecords" and "dataRecordsOnly".  
Public PropertyPersistEnables / disables groupby persistence between states  
Public PropertyRegionalGets/sets the Regional of the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyRemoveButtonTooltipRemove GroupBy button tooltip  
Public PropertyResultResponseKeyspecifies a key to get group by data from the result response  
Public PropertySummarySettingssummary settings  
Public PropertyTypeoperation type - Local or Remote  
Public PropertyUseGridColumnFormatterFormat grouped column using the formatter set in igGrid.columns[i].formatter or igGrid format  
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub