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

Represents a filter that can be applied to a MixedCollection. Can either simply filter on a property/value pair or pass in a filter function with custom logic. Filters are always used in the context of MixedCollections, though Stores frequently create them when filtering and searching on their records. More...

Inheritance diagram for Ext.Net.DataFilter:
Ext.Net.BaseItem Ext.Net.IXObject Ext.Net.IBase

Classes

class  Builder
 
class  Config
 

Public Member Functions

 DataFilter ()
 
DataFilter.Builder ToBuilder ()
 
override IControlBuilder ToNativeBuilder ()
 
 DataFilter (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 DataFilter[] From (string value)
 
static implicit operator DataFilter (DataFilter.Config config)
 

Properties

virtual bool AnyMatch [get, set]
 True to allow any match - no regex start/end line anchors will be added. Defaults to false More...
 
virtual bool CaseSensitive [get, set]
 True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false. More...
 
virtual ? bool? DisableOnEmpty [get, set]
 true to not have this filter participate in the filtering process when the value of this the filter is empty according to Ext.isEmpty. Defaults to false. More...
 
virtual bool ExactMatch [get, set]
 True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true. More...
 
virtual JFunction FilterFn [get]
 A custom filter function which is passed each item in the Ext.util.MixedCollection in turn. Should return true to accept each item or false to reject it Parameters item : data item More...
 
virtual string Property [get, set]
 The property to filter on. Required unless a filter is passed More...
 
virtual string Root [get, set]
 Optional root property. This is mostly useful when filtering 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 string Scope [get, set]
 The context (this property) in which the filtering function is called. Defaults to this Filter object. More...
 
virtual string Value [get, set]
 Filter value More...
 
virtual object RawValue [get, set]
 Filter value More...
 
virtual string Op [get, set]
 The operator to use to compare the property to this Filter's value Possible values are: < <= = >= > != in like The in operator expects this filter's value to be an array and matches values that are present in that array. The like operator matches values that contain this filter's value as a substring. 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 filter that can be applied to a MixedCollection. Can either simply filter on a property/value pair or pass in a filter function with custom logic. Filters are always used in the context of MixedCollections, though Stores frequently create them when filtering and searching on their records.

Constructor & Destructor Documentation

◆ DataFilter() [1/2]

Ext.Net.DataFilter.DataFilter ( )
inline

◆ DataFilter() [2/2]

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

Member Function Documentation

◆ From()

static DataFilter [] Ext.Net.DataFilter.From ( string  value)
inlinestatic

Parameters
value
Returns

◆ operator DataFilter()

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

◆ ToBuilder()

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

◆ ToNativeBuilder()

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

Reimplemented from Ext.Net.BaseItem.

Property Documentation

◆ AnyMatch

virtual bool Ext.Net.DataFilter.AnyMatch
getset

True to allow any match - no regex start/end line anchors will be added. Defaults to false

◆ CaseSensitive

virtual bool Ext.Net.DataFilter.CaseSensitive
getset

True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false.

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.DataFilter.ConfigOptions
get

◆ DisableOnEmpty

virtual ? bool? Ext.Net.DataFilter.DisableOnEmpty
getset

true to not have this filter participate in the filtering process when the value of this the filter is empty according to Ext.isEmpty. Defaults to false.

◆ ExactMatch

virtual bool Ext.Net.DataFilter.ExactMatch
getset

True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true.

◆ FilterFn

virtual JFunction Ext.Net.DataFilter.FilterFn
get

A custom filter function which is passed each item in the Ext.util.MixedCollection in turn. Should return true to accept each item or false to reject it Parameters item : data item

◆ Op

virtual string Ext.Net.DataFilter.Op
getset

The operator to use to compare the property to this Filter's value Possible values are: < <= = >= > != in like The in operator expects this filter's value to be an array and matches values that are present in that array. The like operator matches values that contain this filter's value as a substring.

◆ Property

virtual string Ext.Net.DataFilter.Property
getset

The property to filter on. Required unless a filter is passed

◆ RawValue

virtual object Ext.Net.DataFilter.RawValue
getset

Filter value

◆ Root

virtual string Ext.Net.DataFilter.Root
getset

Optional root property. This is mostly useful when filtering 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

◆ Scope

virtual string Ext.Net.DataFilter.Scope
getset

The context (this property) in which the filtering function is called. Defaults to this Filter object.

◆ Value

virtual string Ext.Net.DataFilter.Value
getset

Filter value


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