Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.DataGrouper Class Reference

Represents a grouping of items. The grouper works in a similar fashion as the Ext.util.Sorter except that groups must be able to extract a value by which all items in the group can be collected. By default this is derived from the property config but can be customized using the groupFn if necessary. All items with the same group value compare as equal. If the group values do not compare equally, the sort can be controlled further by setting sortProperty or sorterFn. More...

Inheritance diagram for Ext.Net.DataGrouper:
Ext.Net.DataSorter Ext.Net.BaseItem Ext.Net.IXObject Ext.Net.IBase

Classes

class  Builder
 
class  Config
 

Public Member Functions

 DataGrouper ()
 The constructor More...
 
DataGrouper.Builder ToBuilder ()
 
override IControlBuilder ToNativeBuilder ()
 
 DataGrouper (Config config)
 
- Public Member Functions inherited from Ext.Net.DataSorter
 DataSorter ()
 
DataSorter.Builder ToBuilder ()
 
override IControlBuilder ToNativeBuilder ()
 
 DataSorter (Config config)
 
- Public Member Functions inherited from Ext.Net.BaseItem
virtual bool HasExplicitValue (string name)
 
void EnsureDataBind ()
 
virtual void Call (string name)
 
virtual void Call (string name, params object[] args)
 
virtual void AddScript (string script)
 
virtual void AddScript (string script, params object[] args)
 
virtual bool IsEmptyObject ()
 
Apply< T > (IApply config)
 
BaseItem Apply (object config)
 
virtual void LoadViewState (object state)
 
virtual object SaveViewState ()
 
virtual void TrackViewState ()
 
void SetDirty ()
 
virtual void DataBind ()
 

Static Public Member Functions

static implicit operator DataGrouper (DataGrouper.Config config)
 
- Static Public Member Functions inherited from Ext.Net.DataSorter
static DataSorter[] From (string value)
 
static implicit operator DataSorter (DataSorter.Config config)
 

Properties

virtual JFunction GroupFn [get]
 This function is called for each item in the collection to determine the group to which it belongs. By default the property value is used to group items. More...
 
virtual string SortProperty [get, set]
 You can set this configuration if you want the groups to be sorted on something other then the group string returned by the groupFn. This serves the same role as property on a normal Ext.util.Sorter. More...
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.DataSorter
SortDirection Direction [get, set]
 The direction to sort by. Defaults to ASC More...
 
string ID [get, set]
 An optional id this sorter can be keyed by in Collections. If no id is specified it will use the property name used in this Sorter. If no property is specified, e.g. when adding a custom sorter function we will generate a random id. More...
 
virtual string Property [get, set]
 The property to sort by. Required unless sorterFn is provided More...
 
virtual string Root [get, set]
 Optional root property. This is mostly useful when sorting a Store, in which case we set the root to 'data' to make the filter pull the property out of the data object of each item More...
 
virtual JFunction SorterFn [get]
 A specific sorter function to execute. Can be passed instead of property Parameters item1 : first data item item2 : second data item More...
 
virtual JFunction Transform [get]
 function that will be run on each value before it is compared in the sorter. The function will receive a single argument, the value. Parameters item : data item More...
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.BaseItem
virtual string InstanceOf [get]
 
ItemState State [get]
 
virtual DefaultValueMode DefaultValueMode [get, set]
 
virtual bool DesignMode [get]
 
bool AutoDataBind [get, set]
 
ResourceManager ResourceManager [get]
 
virtual Control Owner [get, set]
 The Owner Control for this Listener. More...
 
virtual bool IsDefault [get]
 Does this object currently represent it's default state. More...
 
bool IsTrackingViewState [get]
 
EventHandlerList Events [get]
 
EventHandler DataBinding
 
Control?? BindingContainer [get]
 
virtual ConfigItemCollection?? CustomConfig [get]
 Collection of custom js config More...
 
virtual ConfigOptionsCollection ConfigOptions [get]
 
virtual ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
System.Web.Mvc.HtmlHelper?? HtmlHelper [get, set]
 
- Properties inherited from Ext.Net.IXObject
ConfigOptionsCollection ConfigOptions [get]
 
ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
DefaultValueMode DefaultValueMode [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from Ext.Net.BaseItem
 BaseItem (Control owner)
 
 BaseItem ()
 
virtual void OwnerUpdate (Control owner)
 
virtual void OnDataBinding (EventArgs e)
 

Detailed Description

Represents a grouping of items. The grouper works in a similar fashion as the Ext.util.Sorter except that groups must be able to extract a value by which all items in the group can be collected. By default this is derived from the property config but can be customized using the groupFn if necessary. All items with the same group value compare as equal. If the group values do not compare equally, the sort can be controlled further by setting sortProperty or sorterFn.

Constructor & Destructor Documentation

◆ DataGrouper() [1/2]

Ext.Net.DataGrouper.DataGrouper ( )
inline

The constructor

◆ DataGrouper() [2/2]

Ext.Net.DataGrouper.DataGrouper ( Config  config)
inline

Member Function Documentation

◆ operator DataGrouper()

static implicit Ext.Net.DataGrouper.operator DataGrouper ( DataGrouper.Config  config)
inlinestatic

◆ ToBuilder()

DataGrouper.Builder Ext.Net.DataGrouper.ToBuilder ( )
inline

◆ ToNativeBuilder()

override IControlBuilder Ext.Net.DataGrouper.ToNativeBuilder ( )
inlinevirtual

Reimplemented from Ext.Net.BaseItem.

Property Documentation

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.DataGrouper.ConfigOptions
get

◆ GroupFn

virtual JFunction Ext.Net.DataGrouper.GroupFn
get

This function is called for each item in the collection to determine the group to which it belongs. By default the property value is used to group items.

Parameters: item: object The current item from the collection.

◆ SortProperty

virtual string Ext.Net.DataGrouper.SortProperty
getset

You can set this configuration if you want the groups to be sorted on something other then the group string returned by the groupFn. This serves the same role as property on a normal Ext.util.Sorter.


The documentation for this class was generated from the following files: