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

AbstractStore is a superclass of Ext.data.Store and Ext.data.TreeStore. It's never used directly, but offers a set of methods used by both of those subclasses. We've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what you're probably looking for is Ext.data.Store. If you're still interested, here's a brief description of what AbstractStore is and is not. AbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be given a Model that represents the type of data in the Store. It also expects to be given a Proxy that handles the loading of data into the Store. AbstractStore provides a few helpful methods such as load and sync, which load and save data respectively, passing the requests through the configured proxy. Both built-in Store subclasses add extra behavior to each of these functions. Note also that each AbstractStore subclass has its own way of storing data - in Ext.data.Store the data is saved as a flat MixedCollection, whereas in TreeStore we use a Ext.data.Tree to maintain the data's hierarchy. The store provides filtering and sorting support. This sorting/filtering can happen on the client side or can be completed on the server. This is controlled by the remoteSort and remoteFilter config options. For more information see the sort and filter methods. More...

Inheritance diagram for Ext.Net.AbstractStore:
Ext.Net.Observable Ext.Net.BaseControl Ext.Net.ILazyItems Ext.Net.IXObject Ext.Net.IBase Ext.Net.LegendStore Ext.Net.StoreBase Ext.Net.TreeStoreBase Ext.Net.SyncStoreBase Ext.Net.TreeStore Ext.Net.Store Ext.Net.CalendarStore Ext.Net.ClientStore Ext.Net.EventStore Ext.Net.ModelStateStore

Classes

class  Builder
 
class  Builder
 
class  Builder
 
class  Config
 

Public Member Functions

virtual void SetReloadOnClearSorters (bool? reloadOnClearSorters)
 Sets the value of reloadOnClearSorters. More...
 
virtual void AddFilter (DataFilterCollection filters)
 Adds a new Filter to this Store's filter set and by default, applies the updated filter set to the Store's unfiltered dataset. More...
 
virtual void AddFilter (FilterQuery filter)
 Adds a new Filter to this Store's filter set and by default, applies the updated filter set to the Store's unfiltered dataset. More...
 
virtual void BeginUpdate ()
 This method may be called to indicate the start of multiple changes to the store. Automatic synchronization as configured by the autoSync flag is deferred until the endUpdate method is called, so multiple mutations can be coalesced into one synchronization operation. Internally this method increments a counter that is decremented by endUpdate. It is important, therefore, that if you call beginUpdate directly you match that call with a call to endUpdate or you will prevent the collection from updating properly. Fires BeginUpdate. More...
 
virtual void ClearGrouping ()
 Clear the store grouping. Fires DataChanged, GroupChange, Refresh. More...
 
virtual void EndUpdate ()
 This method is called after modifications are complete on a store. For details see beginUpdate. Fires BeforeSync, EndUpdate. More...
 
virtual ModelProxy Find (string fieldName, string value)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy Find (string fieldName, string value, int startIndex)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy Find (string fieldName, string value, int startIndex, bool anyMatch)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy Find (string fieldName, string value, int startIndex, bool anyMatch, bool caseSensitive)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy Find (string fieldName, string value, int startIndex, bool anyMatch, bool caseSensitive, bool exactMatch)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy FindRegex (string fieldName, string regex)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy FindRegex (string fieldName, string regex, int startIndex)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy FindRegex (string fieldName, string regex, int startIndex, bool anyMatch)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy FindRegex (string fieldName, string regex, int startIndex, bool anyMatch, bool caseSensitive)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy FindRegex (string fieldName, string regex, int startIndex, bool anyMatch, bool caseSensitive, bool exactMatch)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy FindBy (JFunction fn, string scope, int startIndex)
 Find the index of the first matching Record in this Store by a function. If the function returns true it is considered a match. More...
 
virtual ModelProxy FindBy (JFunction fn, string scope)
 Find the index of the first matching Record in this Store by a function. If the function returns true it is considered a match. More...
 
virtual ModelProxy FindBy (JFunction fn)
 Find the index of the first matching Record in this Store by a function. If the function returns true it is considered a match. More...
 
virtual ModelProxy FindExact (string fieldName, object value, int startIndex)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy FindExact (string fieldName, object value)
 Finds the index of the first matching Record in this store by a specific field value. More...
 
virtual ModelProxy GetAt (int index)
 Get the model proxy at the specified index. More...
 
virtual ModelProxy GetById (object id)
 Get the model proxy with the specified id. More...
 
virtual void Group (string field, SortDirection direction)
 Groups data inside the store. Fires DataChanged, GroupChange, Refresh. More...
 
virtual void Group (string field)
 Groups data inside the store. More...
 
virtual void Group (DataSorterCollection groupers)
 Groups data inside the store. More...
 
virtual void Group (DataSorterCollection groupers, SortDirection direction)
 Groups data inside the store. More...
 
virtual void LoadProxy (object options)
 Loads data into the Store via the configured proxy. This uses the Proxy to make an asynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved instances into the Store and calling an optional callback if required. More...
 
virtual void LoadProxy ()
 Loads data into the Store via the configured proxy. This uses the Proxy to make an asynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved instances into the Store and calling an optional callback if required. More...
 
virtual void Reload ()
 Reloads the Store. More...
 
virtual void Reload (object options)
 Reloads the Store. More...
 
virtual void Reload (object options, AbstractProxy proxy)
 Reloads the Store. More...
 
virtual void Reload (ParameterCollection parameters)
 Reloads the Store. More...
 
virtual void SetAutoDestroy (bool autoDestroy)
 Sets autoDestroy. More...
 
virtual void SetAsynchronousLoad (bool asynchronousLoad)
 Sets the value of AsynchronousLoad More...
 
virtual void SetClearOnPageLoad (bool clearOnPageLoad)
 Sets the value of clearOnPageLoad. More...
 
virtual void SetClearRemovedOnLoad (bool clearRemovedOnLoad)
 Sets the value of clearRemovedOnLoad. More...
 
virtual void SetFilters (DataFilterCollection filters)
 Sets filters. More...
 
virtual void SetGroupDir (SortDirection groupDir)
 Sets groupDir. More...
 
virtual void SetGrouper (DataGrouper grouper)
 Sets the value of grouper. More...
 
virtual void SetGroupField (string groupField)
 Sets groupField. More...
 
virtual void SetPageSize (int pageSize)
 Sets pageSize. More...
 
virtual void SetRemoteFilter (bool remoteFilter)
 Sets remoteFilter. More...
 
virtual void SetRemoteSort (bool remoteSort)
 Sets remoteSort. More...
 
virtual void SetProxy (string proxyType)
 Sets the Store's Proxy by string More...
 
virtual void SetProxy (AbstractProxy proxy)
 Sets the Store's Proxy by instance More...
 
void SetProxyUrl (string url)
 Sets the new URL for the Store's Proxy More...
 
void SetSorters (DataSorterCollection sorters)
 Sets sorters. More...
 
void SetStatefulFilters (bool statefulFilters)
 Sets statefulFilters More...
 
void SetStoreId (string storeId)
 Sets storeId. More...
 
virtual void Sync ()
 Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated and deleted records in the store, updating the Store's internal representation of the records as each operation completes. More...
 
virtual void ResumeAutoSync ()
 Resumes automatically syncing the Store with its Proxy. Only applicable if autoSync is true More...
 
virtual void RemoveFilter (string filterId)
 Removes an individual Filter from the current filter set using the passed Filter id and by default, applies the updated filter set to the Store's unfiltered dataset. More...
 
virtual void SuspendAutoSync ()
 Suspends automatically syncing the Store with its Proxy. Only applicable if autoSync is true More...
 
- Public Member Functions inherited from Ext.Net.Observable
virtual void AddListener (string eventName, JFunction fn)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, JFunction fn, string scope)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, JFunction fn, string scope, HandlerConfig options)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, string fn)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, string fn, string scope)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, string fn, string scope, HandlerConfig options)
 Appends an event handler to this component More...
 
virtual void AddManagedListener (string item, string eventName, string fn, string scope, HandlerConfig options)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void AddManagedListener (string item, string eventName, string fn, string scope)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void AddManagedListener (string item, string eventName, string fn)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void ClearListeners ()
 Removes all listeners for this object including the managed listeners More...
 
virtual void ClearManagedListeners ()
 Removes all managed listeners for this object. More...
 
virtual void EnableBubble (params string[] events)
 Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class. This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.AbstractComponent-getBubbleTarget. The default implementation in Ext.AbstractComponent returns the AbstractComponent's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. More...
 
virtual void FireEvent (string eventName, params object[] args)
 Fires the specified event with the passed parameters (minus the event name) More...
 
virtual void FireEventedAction (string eventName, object[] args, string fn)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, string fn, string scope)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, string fn, string scope, object[] fnArgs)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, JFunction fn)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, JFunction fn, string scope)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, JFunction fn, string scope, object[] fnArgs)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void On (string eventName, string fn)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, string fn, string scope)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, string fn, string scope, HandlerConfig options)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, JFunction fn)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, JFunction fn, string scope)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, JFunction fn, string scope, HandlerConfig options)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void RelayEvents (string origin, string[] events)
 Relays selected events from the specified Observable as if the events were fired by this. More...
 
virtual void RemoveListener (string eventName, string fn)
 Removes an event handler. More...
 
virtual void RemoveListener (string eventName, string fn, string scope)
 Removes an event handler. More...
 
virtual void RemoveManagedListener (string item, string eventName, string fn)
 Removes listeners that were added by the mon method. More...
 
virtual void RemoveManagedListener (string item, string eventName, string fn, string scope)
 Removes listeners that were added by the mon method. More...
 
virtual void ResumeEvents ()
 Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now. More...
 
virtual void SuspendEvents (bool queueSuspended)
 Suspend the firing of all events. (see resumeEvents) More...
 
virtual void SuspendEvents ()
 Suspend the firing of all events. (see resumeEvents) More...
 
virtual void SuspendEvent (string name)
 Suspends firing of the named event(s). More...
 
virtual void ResumeEvent (string name)
 Resumes firing of the named event(s). More...
 
virtual void RemoveDirectListener (string name)
 
virtual void Un (string eventName, string fn)
 Removes a listener (shorthand for removeListener) More...
 
virtual void Un (string eventName, string fn, string scope)
 Removes a listener (shorthand for removeListener) More...
 
virtual void Mon (Element el, string eventName, JFunction fn)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Observable el, string eventName, JFunction fn)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Element el, string eventName, JFunction fn, string scope)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Observable el, string eventName, JFunction fn, string scope)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Element el, string eventName, string fn, string scope, HandlerConfig options)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Observable el, string eventName, string fn, string scope, HandlerConfig options)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mun (Element el, string eventName, string fn)
 Removes listeners that were added by the mon method. More...
 
virtual void Mun (Observable el, string eventName, string fn)
 Removes listeners that were added by the mon method. More...
 
virtual void Mun (Element el, string eventName, string fn, string scope)
 Removes listeners that were added by the mon method. More...
 
virtual void Mun (Observable el, string eventName, string fn, string scope)
 Removes listeners that were added by the mon method. More...
 
delegate void OnBeforeClientInitializedHandler (Observable sender)
 
delegate void OnAfterClientInitializedHandler (Observable sender)
 
- Public Member Functions inherited from Ext.Net.BaseControl
virtual bool HasExplicitValue (string name)
 
virtual IControlBuilder ToNativeBuilder ()
 
virtual T ToBuilder< T > ()
 
Apply< T > (IApply config)
 
object Apply (IApply config)
 
BaseControl Apply (object from, bool ignoreDefaultValues)
 
BaseControl Apply (object from)
 
virtual bool HasLayout ()
 
virtual bool HasContent ()
 
virtual string ResolveUrlLink (string url)
 
bool IsInHierarchy (params Type[] types)
 
GetParentByLevel< T > (int level)
 
virtual string DefineInstance ()
 
virtual string DefineInstance (string config)
 
virtual string DefineInstance (string instanceOf, string config)
 
virtual string ToConfig ()
 
virtual string ToConfig (LazyMode mode)
 
virtual string ToConfig (LazyMode mode, bool registerResourcesInManager)
 
virtual string ToScript (bool selfRendering)
 
virtual string ToScript ()
 
string ToScript (RenderMode mode, string element)
 
string ToScript (RenderMode mode, string element, bool selfRendering)
 
string ToScript (RenderMode mode, string element, int index)
 
string ToScript (RenderMode mode, string element, int index, bool selfRendering)
 
string ToScript (RenderMode mode, string element, int? index, bool? selfRendering, bool forceResources, string method, bool forceLazy, bool clearContainer)
 
virtual void AddScript (string script)
 Adds the script to be be called on the client. More...
 
virtual void AddScript (string template, params object[] args)
 Adds the script to be be called on the client. The script is formatted using the template and args. More...
 
virtual void Set (string name, object value)
 
virtual void Set (ScriptPosition position, string name, object value)
 
virtual void Call (string name)
 
virtual void Call (string name, params object[] args)
 
virtual void Call (string name, string[] arg)
 Calls the JavaScript function on the Control with a string[] parameter More...
 
virtual void Call (ScriptPosition mode, string name, params object[] args)
 
virtual string SelfRender ()
 
virtual void AddBeforeClientInitScript (string script)
 Adds the script directly before the ClientInitScript. More...
 
virtual void AddAfterClientInitScript (string script)
 Adds the script directly after the ClientInitScript. More...
 
override void RenderBeginTag (HtmlTextWriter writer)
 
virtual void Render (bool selfRendering)
 
virtual void Render (Control control)
 
virtual void Render ()
 
virtual void Render (string element, RenderMode mode)
 
virtual void Render (string element, int index, RenderMode mode)
 
virtual void Render (Control control, RenderMode mode)
 
virtual void Render (Control control, int index, RenderMode mode)
 
virtual void Render (string element, RenderMode mode, bool selfRendering)
 
virtual void Render (string element, int index, RenderMode mode, bool selfRendering)
 
virtual void Render (RenderMode mode, string element, int? index, bool? selfRendering, bool forceResources, string method, bool forceLazy, bool clearContainer)
 
virtual void Render (Control control, RenderMode mode, bool selfRendering)
 
virtual void Render (Control control, int index, RenderMode mode, bool selfRendering)
 
virtual void AddTo (string element)
 
virtual void AddTo (Control control)
 
virtual void AddTo (string element, bool selfRendering)
 
virtual void AddTo (Control control, bool selfRendering)
 
virtual void InsertTo (int index, string element)
 
virtual void InsertTo (int index, Control control)
 
virtual void InsertTo (int index, string element, bool selfRendering)
 
virtual void InsertTo (int index, Control control, bool selfRendering)
 
virtual void Update ()
 
virtual bool SuspendScripting ()
 
virtual void ResumeScripting (bool oldValue)
 
virtual void ResumeScripting ()
 
virtual void Destroy ()
 
List< T > GetCustomResources< T > ()
 
virtual void SetResources ()
 
List< ClientStyleItemGetStyles ()
 
List< ClientStyleItemGetThemes ()
 
List< ClientScriptItemGetScripts ()
 
string GetGeneratedScripts ()
 Get generated and added javascript methods calling More...
 
virtual bool HasOwnState (string name)
 
virtual void SetControlFor (ModelMetadata meta)
 

Protected Member Functions

override void OnBeforeClientInit (Observable sender)
 
virtual void Proxy_AfterItemAdd (BaseItem item)
 
- Protected Member Functions inherited from Ext.Net.Observable
override void OnInit (EventArgs e)
 
virtual void RegisterCustomAttribute (string key, string value)
 
virtual void OnAfterClientInit (Observable sender)
 
virtual void OnBeforeClientInitHandler ()
 
virtual void OnAfterClientInitHandler ()
 
override void OnPreRender (EventArgs e)
 
override void PreRenderAction ()
 
virtual void AfterItemAdd (Observable item)
 
virtual void AfterItemRemove (Observable item)
 
override void SetModelAdditionalValue (KeyValuePair< string, object > value)
 
- Protected Member Functions inherited from Ext.Net.BaseControl
virtual string GetNamespace (bool parseDot)
 
virtual string AddNamespaceToID (string id)
 
virtual ContentContainer CreateContainer ()
 
virtual void CheckForceId ()
 
virtual string ParseTarget (string target)
 
Unit UnitPixelTypeCheck (object obj, Unit defaultValue, string propertyName)
 
virtual void CallTemplate (string template)
 
virtual void CallTemplate (string template, string name, params object[] args)
 
virtual void CallTemplate (ScriptPosition position, string template, string name, params object[] args)
 
override void OnInit (EventArgs e)
 
virtual void PagePreLoad (object sender, EventArgs e)
 
virtual void PageLoad (object sender, EventArgs e)
 
virtual void PageLoadComplete (object sender, EventArgs e)
 
override void AddAttributesToRender (HtmlTextWriter writer)
 
virtual void SimpleRender (HtmlTextWriter writer)
 
virtual void RecreateChildControls ()
 
override void CreateChildControls ()
 
override void OnPreRender (EventArgs e)
 
virtual void RenderScript (string script)
 
override void OnDataBinding (EventArgs e)
 
override void Render (HtmlTextWriter writer)
 
virtual bool IsGlobalResourceRegistered (ResourceItem item)
 
virtual string FormatValue (object value, string format)
 
virtual void OnMetadataProcess (ModelMetadata meta, string name, ViewDataDictionary viewData, ControllerContext context)
 
virtual void SetModelValidationRule (ModelClientValidationRule rule)
 
virtual void SetModelValue (object value, ModelMetadata meta)
 

Properties

override string InstanceOf [get]
 
override string ConfigIDProxy [get]
 
override string AliasPrefix [get]
 
virtual string StoreType [get]
 
string? StoreTypeProxy [get]
 
override bool RemoveContainer [get]
 
virtual bool AutoDestroy [get, set]
 true to destroy the store when the component the store is bound to is destroyed (defaults to true). Note: this should be set to true when using stores that are bound to only 1 component and this should be set to false for a store which is associated to a few components. More...
 
virtual ? bool? AsynchronousLoad [get, set]
 This defaults to true when this store's proxy is asynchronous, such as an Ajax proxy. When the proxy is synchronous, such as a Ext.data.proxy.Memory memory proxy, this defaults to false. NOTE: This does not cause synchronous Ajax requests if configured false when an Ajax proxy is used. It causes immediate issuing of an Ajax request when load is called rather than issuing the request at the end of the current event handler run. What this means is that when using an Ajax proxy, calls to load do not fire the request to the remote resource immediately, but schedule a request to be made. This is so that multiple requests are not fired when mutating a store's remote filters and sorters (as happens during state restoration). The request is made only once after all relevant store state is fully set. More...
 
virtual bool AutoLoad [get, set]
 If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method. Defaults to false. More...
 
virtual bool IsAutoLoadUndefined [get]
 
virtual bool AutoLoadProxy [get]
 
virtual ParameterCollection?? AutoLoadParams [get]
 If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method. More...
 
ParameterCollection AutoLoadParamsProxy [get]
 
virtual int PageSize [get, set]
 The number of records considered to form a 'page'. This is used to power the built-in paging using the nextPage and previousPage functions when the grid is paged using a PagingToolbar. To disable paging, set the pageSize to 0. Defaults to: 25 More...
 
virtual StoreParameterCollection?? Parameters [get]
 An object containing properties which are to be sent as parameters on any HTTP request. More...
 
virtual string? ParametersProxy [get]
 
virtual StoreParameterCollection?? SyncParameters [get]
 An object containing properties which are to be sent as parameters on sync request. More...
 
virtual string? SyncParametersProxy [get]
 
virtual bool AutoSync [get, set]
 True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false. More...
 
virtual ProxyCollection Proxy [get]
 The Proxy to use for this Store. More...
 
virtual ? bool? ReloadOnClearSorters [get, set]
 Set this to true to trigger a reload when the last sorter is removed (only applicable when remoteSort is true). More...
 
virtual bool RemoteFilter [get, set]
 True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to false. More...
 
virtual bool RemoteSort [get, set]
 True to defer any sorting operation to the server. If false, sorting is done locally on the client. Defaults to false. More...
 
virtual string SyncUrl [get, set]
 
virtual ProxyCollection?? ServerProxy [get]
 The Proxy to use for reload or sync actions when Memory proxy is used for initial data More...
 
virtual BatchUpdateMode BatchUpdateMode [get, set]
 Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's internal representation of the data after each operation of the batch has completed, 'complete' will wait until the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency. More...
 
virtual bool ClearOnPageLoad [get, set]
 True to empty the store when loading another page via loadPage, nextPage or previousPage (defaults to true). Setting to false keeps existing records, allowing large data sets to be loaded one page at a time but rendered all together. Defaults to: true More...
 
virtual bool ClearRemovedOnLoad [get, set]
 True to clear anything in the removed record collection when the store loads. More...
 
virtual bool FilterOnLoad [get, set]
 If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, ignored if remoteFilter is true More...
 
virtual DataFilterCollection?? Filters [get]
 The collection of Filters currently applied to this Store More...
 
virtual SortDirection GroupDir [get, set]
 The direction in which sorting should be applied when grouping. Defaults to "ASC" - the other supported value is "DESC" More...
 
virtual string GroupField [get, set]
 The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the groupField and groupDir are injected as the first sorter (see sort). Stores support a single level of grouping, and groups can be fetched via the getGroups method. More...
 
virtual DataGrouper?? Grouper [get]
 The grouper by which to group the data store. May also be specified by the groupField config, however they should not be used together. More...
 
virtual bool SortOnLoad [get, set]
 If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, igored if remoteSort is true More...
 
virtual string SortRoot [get, set]
 The field name by which to sort the store's data (defaults to ''). More...
 
virtual DataSorterCollection?? Sorters [get]
 The collection of Sorters currently applied to this Store More...
 
bool ShowWarningOnFailure [get, set]
 Show warning if request fail. More...
 
bool StatefulFilters [get, set]
 Configure as true to have the filters saved when a client grid saves its state. Defaults to: false More...
 
virtual string ModelName [get, set]
 The Ext.data.Model associated with this store More...
 
virtual ModelCollection Model [get]
 
virtual ModelFieldCollection Fields [get]
 The fields for this model. This is an Array of Field definition objects. A Field definition may simply be the name of the Field, but a Field encapsulates data type, custom conversion of raw data, and a mapping property to specify by name of index, how to extract a field's value from a raw data object, so it is best practice to specify a full set of Field config objects. More...
 
virtual Model ModelInstance [get]
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.Observable
virtual List< Observable >?? LazyItems [get]
 
virtual bool SingleItemMode [get]
 
virtual ConfigItemCollection?? CustomConfig [get]
 Collection of custom js config More...
 
DynamicConfigDictionary ConfigsProxy [get]
 
virtual string DirectEventsKey [get]
 
MessageBusListeners MessageBusListeners [get]
 
MessageBusDirectEvents MessageBusDirectEvents [get]
 
virtual string MessageBusListenersProxy [get]
 
virtual string MessageBusDirectEventsProxy [get]
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.BaseControl
string ProductName [get]
 The product name More...
 
virtual string Version [get]
 The Version number of this build More...
 
string DynamicID [get]
 
override string ID [get, set]
 The unique id of this component instance (defaults to an auto-assigned id). Components created with an id may be accessed globally using Ext.getCmp. You can use the itemId config, and ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The Container class contains shortcut methods to query its descendant Components by selector. Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent. Note: to avoid complications imposed by a unique id also see itemId. Note: to access the container of a AbstractComponent see ownerCt. More...
 
override string ClientID [get]
 
virtual string ItemID [get, set]
 An itemId can be used as an alternative way to get a reference to a component when no object reference is available. Instead of using an id with Ext.getCmp, use itemId with Ext.container.Container.getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the itemId is scoped locally to the container – avoiding potential conflicts with Ext.ComponentMgr which requires a unique id More...
 
virtual string???? ConfigID [get]
 
virtual string BaseClientID [get]
 The base .ClientID property derived from .NET Framework More...
 
virtual string ConfigIDProxy [get]
 
bool HasOwnIDMode [get]
 
virtual IDMode IDMode [get, set]
 Options for controlling how the .ClientID property is rendered in the client. More...
 
virtual bool StopIDModeInheritance [get, set]
 
virtual bool StopLazyModeInheritance [get, set]
 
virtual LazyModeLazyMode [get, set]
 Options for controlling how the lazy control is instantiated in the client. More...
 
bool HasOwnNamespace [get]
 
virtual string ClientNamespace [get]
 
virtual string Namespace [get, set]
 
virtual string? ClientNamespaceProxy [get]
 
virtual string??? InitialConfig [get]
 This AbstractComponent's initial configuration specification. Read-only. More...
 
virtual bool AutoDataBind [get, set]
 
virtual FactoryConfig Factory [get, set]
 
virtual string FactoryAlias [get, set]
 
virtual string FactoryInstance [get, set]
 
virtual bool TemplateWidget [get, set]
 
virtual string TemplateWidgetFnName [get, set]
 
virtual ConfigOptionsCollection ConfigOptions [get]
 
virtual ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
virtual DefaultValueMode DefaultValueMode [get, set]
 
virtual bool RemoveContainer [get]
 
virtual bool IsMVC [get]
 
static ClientScriptItem UXScriptItem [get]
 
static ClientStyleItem UXStyleItem [get]
 
virtual bool IsDebugging [get]
 
virtual bool IsAjaxRequestInitiator [get]
 
virtual bool IsDefault [get]
 Does this object currently represent it's default state. More...
 
virtual bool IsLazy [get]
 
virtual string? ContainerID [get]
 
virtual string ContainerStyle [get]
 
virtual bool IsInHead [get]
 
virtual bool IsInForm [get]
 
virtual string ClientForm [get]
 
virtual System.Web.UI.HtmlControls.HtmlForm ParentForm [get]
 
virtual AbstractComponent ParentComponent [get]
 
virtual BaseControl ParentWebControl [get]
 
virtual string InstanceOf [get]
 
virtual string AliasPrefix [get]
 
virtual string? ClassName [get]
 
virtual string CallID [get]
 
virtual bool IsGeneratedID [get]
 
bool IsDynamic [get, set]
 Set to true if a control is meant to be dynamically rendered. In absolutely most cases, this is set to true automatically if needed and originally the property was internal. Though, in some very specific and edge cases a developer might need to set it to true by his own. Setting it to true you should be absolutelly sure it is required. For example, if it is recommended by Ext.NET support team. Also it can be changed only to true, but not backwards. Defaults to false. More...
 
virtual bool ContentUpdated [get, set]
 
string BeforeScript [get]
 
string AfterScript [get]
 
virtual AbstractComponent ParentComponentNotLazyOrDynamic [get]
 
virtual bool RenderTags [get]
 
bool RegisterAllResources [get, set]
 
override string ToolTip [get, set]
 
override string AccessKey [get, set]
 
override Color BackColor [get, set]
 
override Color BorderColor [get, set]
 
override System.Web.UI.WebControls.BorderStyle BorderStyle [get, set]
 
override System.Web.UI.WebControls.Unit BorderWidth [get, set]
 
override string CssClass [get, set]
 
override System.Web.UI.WebControls.FontInfo Font [get]
 
override Color ForeColor [get, set]
 
override Unit Height [get, set]
 
override Unit Width [get, set]
 
virtual string PostBackArgument [get, set]
 
virtual string PostBackConfig [get]
 
virtual bool HasResourceManager [get]
 
virtual ResourceManager ResourceManager [get]
 
virtual List< ResourceItemResources [get]
 
virtual List< ClientResourceItemResourceItems [get]
 
virtual List< ResourceItemGlobalResources [get]
 
virtual string? ClientInitScript [get]
 
virtual bool IsInUpdatePanelRefresh [get]
 
virtual Control MyUpdatePanel [get]
 
System.Web.Mvc.HtmlHelper?? HtmlHelper [get, set]
 
System.Web.Mvc.ViewContext ViewContext [get, set]
 
System.Web.Mvc.ControllerBase Controller [get, set]
 
virtual ViewDataDictionary ViewData [get]
 
virtual ControllerContext ControllerContext [get]
 
virtual string ControlFor [get, set]
 
virtual bool IDFromControlFor [get, set]
 
string FormatControlForValue [get, set]
 
Func< object, object > ConvertControlForValue [get, set]
 
- Properties inherited from Ext.Net.IXObject
ConfigOptionsCollection ConfigOptions [get]
 
ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
DefaultValueMode DefaultValueMode [get, set]
 
- Properties inherited from Ext.Net.ILazyItems
List< ObservableLazyItems [get]
 

Additional Inherited Members

- Static Public Member Functions inherited from Ext.Net.BaseControl
static string GenerateID ()
 
static object Apply (object to, object from)
 
static object Apply (object to, object from, bool ignoreDefaultValues)
 
- Events inherited from Ext.Net.Observable
OnBeforeClientInitializedHandler BeforeClientInit
 
OnAfterClientInitializedHandler AfterClientInit
 

Detailed Description

AbstractStore is a superclass of Ext.data.Store and Ext.data.TreeStore. It's never used directly, but offers a set of methods used by both of those subclasses. We've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what you're probably looking for is Ext.data.Store. If you're still interested, here's a brief description of what AbstractStore is and is not. AbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be given a Model that represents the type of data in the Store. It also expects to be given a Proxy that handles the loading of data into the Store. AbstractStore provides a few helpful methods such as load and sync, which load and save data respectively, passing the requests through the configured proxy. Both built-in Store subclasses add extra behavior to each of these functions. Note also that each AbstractStore subclass has its own way of storing data - in Ext.data.Store the data is saved as a flat MixedCollection, whereas in TreeStore we use a Ext.data.Tree to maintain the data's hierarchy. The store provides filtering and sorting support. This sorting/filtering can happen on the client side or can be completed on the server. This is controlled by the remoteSort and remoteFilter config options. For more information see the sort and filter methods.

Member Function Documentation

◆ AddFilter() [1/2]

virtual void Ext.Net.AbstractStore.AddFilter ( DataFilterCollection  filters)
inlinevirtual

Adds a new Filter to this Store's filter set and by default, applies the updated filter set to the Store's unfiltered dataset.

Parameters
filtersThe set of filters to add to the current filter set.

◆ AddFilter() [2/2]

virtual void Ext.Net.AbstractStore.AddFilter ( FilterQuery  filter)
inlinevirtual

Adds a new Filter to this Store's filter set and by default, applies the updated filter set to the Store's unfiltered dataset.

Parameters
filterThe set of filters to add to the current filter set.

◆ BeginUpdate()

virtual void Ext.Net.AbstractStore.BeginUpdate ( )
inlinevirtual

This method may be called to indicate the start of multiple changes to the store. Automatic synchronization as configured by the autoSync flag is deferred until the endUpdate method is called, so multiple mutations can be coalesced into one synchronization operation. Internally this method increments a counter that is decremented by endUpdate. It is important, therefore, that if you call beginUpdate directly you match that call with a call to endUpdate or you will prevent the collection from updating properly. Fires BeginUpdate.

◆ ClearGrouping()

virtual void Ext.Net.AbstractStore.ClearGrouping ( )
inlinevirtual

Clear the store grouping. Fires DataChanged, GroupChange, Refresh.

◆ EndUpdate()

virtual void Ext.Net.AbstractStore.EndUpdate ( )
inlinevirtual

This method is called after modifications are complete on a store. For details see beginUpdate. Fires BeforeSync, EndUpdate.

◆ Find() [1/5]

virtual ModelProxy Ext.Net.AbstractStore.Find ( string  fieldName,
string  value 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
valueEither a string that the field value should begin with, or a RegExp to test against the field.
Returns

◆ Find() [2/5]

virtual ModelProxy Ext.Net.AbstractStore.Find ( string  fieldName,
string  value,
int  startIndex 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
valueEither a string that the field value should begin with, or a RegExp to test against the field.
startIndexThe index to start searching at
Returns

◆ Find() [3/5]

virtual ModelProxy Ext.Net.AbstractStore.Find ( string  fieldName,
string  value,
int  startIndex,
bool  anyMatch 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
valueEither a string that the field value should begin with, or a RegExp to test against the field.
startIndexThe index to start searching at
anyMatchTrue to match any part of the string, not just the beginning
Returns

◆ Find() [4/5]

virtual ModelProxy Ext.Net.AbstractStore.Find ( string  fieldName,
string  value,
int  startIndex,
bool  anyMatch,
bool  caseSensitive 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
valueEither a string that the field value should begin with, or a RegExp to test against the field.
startIndexThe index to start searching at
anyMatchTrue to match any part of the string, not just the beginning
caseSensitiveTrue for case sensitive comparison
Returns

◆ Find() [5/5]

virtual ModelProxy Ext.Net.AbstractStore.Find ( string  fieldName,
string  value,
int  startIndex,
bool  anyMatch,
bool  caseSensitive,
bool  exactMatch 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
valueEither a string that the field value should begin with, or a RegExp to test against the field.
startIndexThe index to start searching at
anyMatchTrue to match any part of the string, not just the beginning
caseSensitiveTrue for case sensitive comparison
exactMatchTrue to force exact match (^ and $ characters added to the regex). Defaults to false.
Returns

◆ FindBy() [1/3]

virtual ModelProxy Ext.Net.AbstractStore.FindBy ( JFunction  fn)
inlinevirtual

Find the index of the first matching Record in this Store by a function. If the function returns true it is considered a match.

Parameters
fnThe function to be called. It will be passed the following parameters: record : Ext.data.Model The record to test for filtering. Access field values using Ext.data.Model.get. id : Object The ID of the Record passed.
Returns

◆ FindBy() [2/3]

virtual ModelProxy Ext.Net.AbstractStore.FindBy ( JFunction  fn,
string  scope 
)
inlinevirtual

Find the index of the first matching Record in this Store by a function. If the function returns true it is considered a match.

Parameters
fnThe function to be called. It will be passed the following parameters: record : Ext.data.Model The record to test for filtering. Access field values using Ext.data.Model.get. id : Object The ID of the Record passed.
scopeThe scope (this reference) in which the function is executed. Defaults to this Store.
Returns

◆ FindBy() [3/3]

virtual ModelProxy Ext.Net.AbstractStore.FindBy ( JFunction  fn,
string  scope,
int  startIndex 
)
inlinevirtual

Find the index of the first matching Record in this Store by a function. If the function returns true it is considered a match.

Parameters
fnThe function to be called. It will be passed the following parameters: record : Ext.data.Model The record to test for filtering. Access field values using Ext.data.Model.get. id : Object The ID of the Record passed.
scopeThe scope (this reference) in which the function is executed. Defaults to this Store.
startIndexThe index to start searching at
Returns

◆ FindExact() [1/2]

virtual ModelProxy Ext.Net.AbstractStore.FindExact ( string  fieldName,
object  value 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
valueThe value to match the field against.
Returns

◆ FindExact() [2/2]

virtual ModelProxy Ext.Net.AbstractStore.FindExact ( string  fieldName,
object  value,
int  startIndex 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
valueThe value to match the field against.
startIndexThe index to start searching at
Returns

◆ FindRegex() [1/5]

virtual ModelProxy Ext.Net.AbstractStore.FindRegex ( string  fieldName,
string  regex 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
regexEither a string that the field value should begin with, or a RegExp to test against the field.
Returns

◆ FindRegex() [2/5]

virtual ModelProxy Ext.Net.AbstractStore.FindRegex ( string  fieldName,
string  regex,
int  startIndex 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
regexEither a string that the field value should begin with, or a RegExp to test against the field.
startIndexThe index to start searching at
Returns

◆ FindRegex() [3/5]

virtual ModelProxy Ext.Net.AbstractStore.FindRegex ( string  fieldName,
string  regex,
int  startIndex,
bool  anyMatch 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
regexEither a string that the field value should begin with, or a RegExp to test against the field.
startIndexThe index to start searching at
anyMatchTrue to match any part of the string, not just the beginning
Returns

◆ FindRegex() [4/5]

virtual ModelProxy Ext.Net.AbstractStore.FindRegex ( string  fieldName,
string  regex,
int  startIndex,
bool  anyMatch,
bool  caseSensitive 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
regexEither a string that the field value should begin with, or a RegExp to test against the field.
startIndexThe index to start searching at
anyMatchTrue to match any part of the string, not just the beginning
caseSensitiveTrue for case sensitive comparison
Returns

◆ FindRegex() [5/5]

virtual ModelProxy Ext.Net.AbstractStore.FindRegex ( string  fieldName,
string  regex,
int  startIndex,
bool  anyMatch,
bool  caseSensitive,
bool  exactMatch 
)
inlinevirtual

Finds the index of the first matching Record in this store by a specific field value.

Parameters
fieldNameThe name of the Record field to test.
regexEither a string that the field value should begin with, or a RegExp to test against the field.
startIndexThe index to start searching at
anyMatchTrue to match any part of the string, not just the beginning
caseSensitiveTrue for case sensitive comparison
exactMatchTrue to force exact match (^ and $ characters added to the regex). Defaults to false.
Returns

◆ GetAt()

virtual ModelProxy Ext.Net.AbstractStore.GetAt ( int  index)
inlinevirtual

Get the model proxy at the specified index.

Parameters
indexThe index of the Record to find.
Returns
The ModelProxy at the passed index.

◆ GetById()

virtual ModelProxy Ext.Net.AbstractStore.GetById ( object  id)
inlinevirtual

Get the model proxy with the specified id.

Parameters
idThe id of the Record to find.
Returns
The ModelProxy at the passed index.

◆ Group() [1/4]

virtual void Ext.Net.AbstractStore.Group ( DataSorterCollection  groupers)
inlinevirtual

Groups data inside the store.

Parameters
groupersAn Array of grouper configurations.

◆ Group() [2/4]

virtual void Ext.Net.AbstractStore.Group ( DataSorterCollection  groupers,
SortDirection  direction 
)
inlinevirtual

Groups data inside the store.

Parameters
groupersAn Array of grouper configurations.
directionThe overall direction to group the data by. Defaults to "ASC".

◆ Group() [3/4]

virtual void Ext.Net.AbstractStore.Group ( string  field)
inlinevirtual

Groups data inside the store.

Parameters
fieldA string name of one of the fields in this Store's configured Model

◆ Group() [4/4]

virtual void Ext.Net.AbstractStore.Group ( string  field,
SortDirection  direction 
)
inlinevirtual

Groups data inside the store. Fires DataChanged, GroupChange, Refresh.

Parameters
fieldA string name of one of the fields in this Store's configured Model
directionThe overall direction to group the data by. Defaults to 'ASC'.

◆ LoadProxy() [1/2]

virtual void Ext.Net.AbstractStore.LoadProxy ( )
inlinevirtual

Loads data into the Store via the configured proxy. This uses the Proxy to make an asynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved instances into the Store and calling an optional callback if required.

◆ LoadProxy() [2/2]

virtual void Ext.Net.AbstractStore.LoadProxy ( object  options)
inlinevirtual

Loads data into the Store via the configured proxy. This uses the Proxy to make an asynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved instances into the Store and calling an optional callback if required.

Parameters
optionsconfig object, passed into the Ext.data.Operation object before loading. Additionally addRecords: true can be specified to add these records to the existing records, default is to remove the Store's existing records first.

◆ OnBeforeClientInit()

override void Ext.Net.AbstractStore.OnBeforeClientInit ( Observable  sender)
inlineprotectedvirtual

◆ Proxy_AfterItemAdd()

virtual void Ext.Net.AbstractStore.Proxy_AfterItemAdd ( BaseItem  item)
inlineprotectedvirtual

◆ Reload() [1/4]

virtual void Ext.Net.AbstractStore.Reload ( )
inlinevirtual

Reloads the Store.

◆ Reload() [2/4]

virtual void Ext.Net.AbstractStore.Reload ( object  options)
inlinevirtual

Reloads the Store.

Parameters
optionsOptional config object. This is passed into the Operation object that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function

◆ Reload() [3/4]

virtual void Ext.Net.AbstractStore.Reload ( object  options,
AbstractProxy  proxy 
)
inlinevirtual

Reloads the Store.

Parameters
optionsOptional config object. This is passed into the Operation object that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function
proxyThe new Proxy, which is an instance

◆ Reload() [4/4]

virtual void Ext.Net.AbstractStore.Reload ( ParameterCollection  parameters)
inlinevirtual

Reloads the Store.

Parameters
parametersOptional config object. This is passed into the Operation object as the options.params that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function

◆ RemoveFilter()

virtual void Ext.Net.AbstractStore.RemoveFilter ( string  filterId)
inlinevirtual

Removes an individual Filter from the current filter set using the passed Filter id and by default, applies the updated filter set to the Store's unfiltered dataset.

Parameters
filterIdThe id of a Filter to remove from the filter set

◆ ResumeAutoSync()

virtual void Ext.Net.AbstractStore.ResumeAutoSync ( )
inlinevirtual

Resumes automatically syncing the Store with its Proxy. Only applicable if autoSync is true

◆ SetAsynchronousLoad()

virtual void Ext.Net.AbstractStore.SetAsynchronousLoad ( bool  asynchronousLoad)
inlinevirtual

Sets the value of AsynchronousLoad

Parameters
asynchronousLoadThe new value

◆ SetAutoDestroy()

virtual void Ext.Net.AbstractStore.SetAutoDestroy ( bool  autoDestroy)
inlinevirtual

Sets autoDestroy.

Parameters
autoDestroyThe new autoDestroy value

◆ SetClearOnPageLoad()

virtual void Ext.Net.AbstractStore.SetClearOnPageLoad ( bool  clearOnPageLoad)
inlinevirtual

Sets the value of clearOnPageLoad.

Parameters
clearOnPageLoadThe new value

◆ SetClearRemovedOnLoad()

virtual void Ext.Net.AbstractStore.SetClearRemovedOnLoad ( bool  clearRemovedOnLoad)
inlinevirtual

Sets the value of clearRemovedOnLoad.

Parameters
clearRemovedOnLoadThe new value

◆ SetFilters()

virtual void Ext.Net.AbstractStore.SetFilters ( DataFilterCollection  filters)
inlinevirtual

Sets filters.

Parameters
filtersThe new filters

◆ SetGroupDir()

virtual void Ext.Net.AbstractStore.SetGroupDir ( SortDirection  groupDir)
inlinevirtual

Sets groupDir.

Parameters
groupDirThe new groupDir

◆ SetGrouper()

virtual void Ext.Net.AbstractStore.SetGrouper ( DataGrouper  grouper)
inlinevirtual

Sets the value of grouper.

Parameters
grouperThe new grouper

◆ SetGroupField()

virtual void Ext.Net.AbstractStore.SetGroupField ( string  groupField)
inlinevirtual

Sets groupField.

Parameters
groupFieldThe new groupField

◆ SetPageSize()

virtual void Ext.Net.AbstractStore.SetPageSize ( int  pageSize)
inlinevirtual

Sets pageSize.

Parameters
pageSizeThe new pageSize

◆ SetProxy() [1/2]

virtual void Ext.Net.AbstractStore.SetProxy ( AbstractProxy  proxy)
inlinevirtual

Sets the Store's Proxy by instance

Parameters
proxyThe new Proxy, which is an instance

◆ SetProxy() [2/2]

virtual void Ext.Net.AbstractStore.SetProxy ( string  proxyType)
inlinevirtual

Sets the Store's Proxy by string

Parameters
proxyTypeThe new Proxy, which is a type string

◆ SetProxyUrl()

void Ext.Net.AbstractStore.SetProxyUrl ( string  url)
inline

Sets the new URL for the Store's Proxy

Parameters
urlThe new URL

◆ SetReloadOnClearSorters()

virtual void Ext.Net.AbstractStore.SetReloadOnClearSorters ( bool?  reloadOnClearSorters)
inlinevirtual

Sets the value of reloadOnClearSorters.

Parameters
reloadOnClearSortersThe new value.

◆ SetRemoteFilter()

virtual void Ext.Net.AbstractStore.SetRemoteFilter ( bool  remoteFilter)
inlinevirtual

Sets remoteFilter.

Parameters
remoteFilterThe new remoteFilter.

◆ SetRemoteSort()

virtual void Ext.Net.AbstractStore.SetRemoteSort ( bool  remoteSort)
inlinevirtual

Sets remoteSort.

Parameters
remoteSortThe new remoteSort.

◆ SetSorters()

void Ext.Net.AbstractStore.SetSorters ( DataSorterCollection  sorters)
inline

Sets sorters.

Parameters
sortersThe new sorters

◆ SetStatefulFilters()

void Ext.Net.AbstractStore.SetStatefulFilters ( bool  statefulFilters)
inline

Sets statefulFilters

Parameters
statefulFiltersThe new statefulFilters

◆ SetStoreId()

void Ext.Net.AbstractStore.SetStoreId ( string  storeId)
inline

Sets storeId.

Parameters
storeIdThe new storeId

◆ SuspendAutoSync()

virtual void Ext.Net.AbstractStore.SuspendAutoSync ( )
inlinevirtual

Suspends automatically syncing the Store with its Proxy. Only applicable if autoSync is true

◆ Sync()

virtual void Ext.Net.AbstractStore.Sync ( )
inlinevirtual

Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated and deleted records in the store, updating the Store's internal representation of the records as each operation completes.

Property Documentation

◆ AliasPrefix

override string Ext.Net.AbstractStore.AliasPrefix
getprotected

◆ AsynchronousLoad

virtual ? bool? Ext.Net.AbstractStore.AsynchronousLoad
getset

This defaults to true when this store's proxy is asynchronous, such as an Ajax proxy. When the proxy is synchronous, such as a Ext.data.proxy.Memory memory proxy, this defaults to false. NOTE: This does not cause synchronous Ajax requests if configured false when an Ajax proxy is used. It causes immediate issuing of an Ajax request when load is called rather than issuing the request at the end of the current event handler run. What this means is that when using an Ajax proxy, calls to load do not fire the request to the remote resource immediately, but schedule a request to be made. This is so that multiple requests are not fired when mutating a store's remote filters and sorters (as happens during state restoration). The request is made only once after all relevant store state is fully set.

◆ AutoDestroy

virtual bool Ext.Net.AbstractStore.AutoDestroy
getset

true to destroy the store when the component the store is bound to is destroyed (defaults to true). Note: this should be set to true when using stores that are bound to only 1 component and this should be set to false for a store which is associated to a few components.

◆ AutoLoad

virtual bool Ext.Net.AbstractStore.AutoLoad
getset

If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method. Defaults to false.

◆ AutoLoadParams

virtual ParameterCollection?? Ext.Net.AbstractStore.AutoLoadParams
get

If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method.

◆ AutoLoadParamsProxy

ParameterCollection Ext.Net.AbstractStore.AutoLoadParamsProxy
getprotected

◆ AutoLoadProxy

virtual bool Ext.Net.AbstractStore.AutoLoadProxy
getprotected

◆ AutoSync

virtual bool Ext.Net.AbstractStore.AutoSync
getset

True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.

◆ BatchUpdateMode

virtual BatchUpdateMode Ext.Net.AbstractStore.BatchUpdateMode
getset

Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's internal representation of the data after each operation of the batch has completed, 'complete' will wait until the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.

◆ ClearOnPageLoad

virtual bool Ext.Net.AbstractStore.ClearOnPageLoad
getset

True to empty the store when loading another page via loadPage, nextPage or previousPage (defaults to true). Setting to false keeps existing records, allowing large data sets to be loaded one page at a time but rendered all together. Defaults to: true

◆ ClearRemovedOnLoad

virtual bool Ext.Net.AbstractStore.ClearRemovedOnLoad
getset

True to clear anything in the removed record collection when the store loads.

◆ ConfigIDProxy

override string Ext.Net.AbstractStore.ConfigIDProxy
getprotected

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.AbstractStore.ConfigOptions
get

◆ Fields

virtual ModelFieldCollection Ext.Net.AbstractStore.Fields
get

The fields for this model. This is an Array of Field definition objects. A Field definition may simply be the name of the Field, but a Field encapsulates data type, custom conversion of raw data, and a mapping property to specify by name of index, how to extract a field's value from a raw data object, so it is best practice to specify a full set of Field config objects.

◆ FilterOnLoad

virtual bool Ext.Net.AbstractStore.FilterOnLoad
getset

If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, ignored if remoteFilter is true

◆ Filters

virtual DataFilterCollection?? Ext.Net.AbstractStore.Filters
get

The collection of Filters currently applied to this Store

◆ GroupDir

virtual SortDirection Ext.Net.AbstractStore.GroupDir
getset

The direction in which sorting should be applied when grouping. Defaults to "ASC" - the other supported value is "DESC"

◆ Grouper

virtual DataGrouper?? Ext.Net.AbstractStore.Grouper
get

The grouper by which to group the data store. May also be specified by the groupField config, however they should not be used together.

◆ GroupField

virtual string Ext.Net.AbstractStore.GroupField
getset

The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the groupField and groupDir are injected as the first sorter (see sort). Stores support a single level of grouping, and groups can be fetched via the getGroups method.

◆ InstanceOf

override string Ext.Net.AbstractStore.InstanceOf
get

◆ IsAutoLoadUndefined

virtual bool Ext.Net.AbstractStore.IsAutoLoadUndefined
get

◆ Model

virtual ModelCollection Ext.Net.AbstractStore.Model
get

◆ ModelInstance

virtual Model Ext.Net.AbstractStore.ModelInstance
get

◆ ModelName

virtual string Ext.Net.AbstractStore.ModelName
getset

The Ext.data.Model associated with this store

◆ PageSize

virtual int Ext.Net.AbstractStore.PageSize
getset

The number of records considered to form a 'page'. This is used to power the built-in paging using the nextPage and previousPage functions when the grid is paged using a PagingToolbar. To disable paging, set the pageSize to 0. Defaults to: 25

◆ Parameters

virtual StoreParameterCollection?? Ext.Net.AbstractStore.Parameters
get

An object containing properties which are to be sent as parameters on any HTTP request.

◆ ParametersProxy

virtual string? Ext.Net.AbstractStore.ParametersProxy
getprotected

◆ Proxy

virtual ProxyCollection Ext.Net.AbstractStore.Proxy
get

The Proxy to use for this Store.

◆ ReloadOnClearSorters

virtual ? bool? Ext.Net.AbstractStore.ReloadOnClearSorters
getset

Set this to true to trigger a reload when the last sorter is removed (only applicable when remoteSort is true).

◆ RemoteFilter

virtual bool Ext.Net.AbstractStore.RemoteFilter
getset

True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to false.

◆ RemoteSort

virtual bool Ext.Net.AbstractStore.RemoteSort
getset

True to defer any sorting operation to the server. If false, sorting is done locally on the client. Defaults to false.

◆ RemoveContainer

override bool Ext.Net.AbstractStore.RemoveContainer
getprotected

◆ ServerProxy

virtual ProxyCollection?? Ext.Net.AbstractStore.ServerProxy
get

The Proxy to use for reload or sync actions when Memory proxy is used for initial data

◆ ShowWarningOnFailure

bool Ext.Net.AbstractStore.ShowWarningOnFailure
getset

Show warning if request fail.

◆ Sorters

virtual DataSorterCollection?? Ext.Net.AbstractStore.Sorters
get

The collection of Sorters currently applied to this Store

◆ SortOnLoad

virtual bool Ext.Net.AbstractStore.SortOnLoad
getset

If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, igored if remoteSort is true

◆ SortRoot

virtual string Ext.Net.AbstractStore.SortRoot
getset

The field name by which to sort the store's data (defaults to '').

◆ StatefulFilters

bool Ext.Net.AbstractStore.StatefulFilters
getset

Configure as true to have the filters saved when a client grid saves its state. Defaults to: false

◆ StoreType

virtual string Ext.Net.AbstractStore.StoreType
getprotected

◆ StoreTypeProxy

string? Ext.Net.AbstractStore.StoreTypeProxy
getprotected

◆ SyncParameters

virtual StoreParameterCollection?? Ext.Net.AbstractStore.SyncParameters
get

An object containing properties which are to be sent as parameters on sync request.

◆ SyncParametersProxy

virtual string? Ext.Net.AbstractStore.SyncParametersProxy
getprotected

◆ SyncUrl

virtual string Ext.Net.AbstractStore.SyncUrl
getset


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