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

More...

Inheritance diagram for Ext.Net.ClientStore.Config:
Ext.Net.Store.Config Ext.Net.SyncStoreBase.Config Ext.Net.StoreBase.Config Ext.Net.AbstractStore.Config Ext.Net.Observable.Config Ext.Net.BaseControl.Config Ext.Net.IApply

Static Public Member Functions

static implicit operator ClientStore.Builder (ClientStore.Config config)
 
- Static Public Member Functions inherited from Ext.Net.Store.Config
static implicit operator Store.Builder (Store.Config config)
 
- Static Public Member Functions inherited from Ext.Net.BaseControl.Config
static Config ToConfig (string config)
 
static TConfig ToConfig< TConfig > (string config)
 

Properties

ClientStoreListeners Listeners [get]
 Client-side JavaScript Event Handlers More...
 
ClientStoreDirectEvents DirectEvents [get]
 Server-side Ajax Event Handlers More...
 
virtual ClientStoreStorage Storage [get, set]
 Specify 'local' to use localStorage and 'session' to use sessionStorage. More...
 
virtual string StorageKey [get, set]
 The key to use for saving the content of this store. More...
 
- Properties inherited from Ext.Net.Store.Config
StoreListeners Listeners [get]
 Client-side JavaScript Event Handlers More...
 
StoreDirectEvents DirectEvents [get]
 Server-side Ajax Event Handlers More...
 
- Properties inherited from Ext.Net.StoreBase.Config
virtual string Source [get, set]
 The backing data source for this chained store. Either a store instance or the id of an existing store. More...
 
virtual bool AutoDecode [get, set]
 If true then submitted data will be decoded More...
 
virtual bool Buffered [get, set]
 Allow the store to buffer and pre-fetch pages of records. This is to be used in conjunction with a view will tell the store to pre-fetch records ahead of a time. More...
 
virtual object Data [get, set]
 Optional array of Model instances or data objects to load locally. See "Inline data" above for details. More...
 
virtual int LeadingBufferZone [get, set]
 When buffered, the number of extra rows to keep cached on the leading side of scrolling buffer as scrolling proceeds. A larger number means fewer replenishments from the server. Defaults to: 200 More...
 
virtual int PurgePageCount [get, set]
 The number of pages to keep in the cache before purging additional records. A value of 0 indicates to never purge the prefetched data. This option is only relevant when the buffered option is set to true. More...
 
virtual bool RemoteGroup [get, set]
 True if the grouping should apply on the server side, false if it is local only (defaults to false). If the grouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a helper, automatically sending the grouping information to the server. More...
 
virtual bool RemotePaging [get, set]
 True to perform remote paging. More...
 
virtual bool IsPagingStore [get, set]
 True to use PagingStore instance More...
 
virtual bool SortOnFilter [get, set]
 For local filtering only, causes sort to be called whenever filter is called, causing the sorters to be reapplied after filtering. Defaults to true More...
 
virtual int TrailingBufferZone [get, set]
 When buffered, the number of extra records to keep cached on the trailing side of scrolling buffer as scrolling proceeds. A larger number means fewer replenishments from the server. Defaults to: 25 More...
 
virtual bool WarningOnDirty [get, set]
 If true show a warning before load/reload if store has dirty data More...
 
virtual string DirtyWarningTitle [get, set]
 The title of window showing before load if the dirty data exists More...
 
virtual string DirtyWarningText [get, set]
 The text of window showing before load if the dirty data exists More...
 
virtual bool IgnoreExtraFields [get, set]
 If true then only properties included to reader will be converted to json More...
 
ReaderCollection Reader [get]
 The Ext.data.reader.Reader to use to decode the server's response. This can either be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml'). More...
 
WriterCollection Writer [get]
 The Ext.data.writer.Writer to use to encode any request sent to the server. This can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml'). More...
 
virtual object DataSource [get, set]
 
virtual string DataSourceID [get, set]
 
virtual string DataMember [get, set]
 
- Properties inherited from Ext.Net.AbstractStore.Config
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. 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...
 
ParameterCollection AutoLoadParams [get]
 An object containing properties which are to be sent as parameters on auto load HTTP request. More...
 
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...
 
StoreParameterCollection Parameters [get]
 An object containing properties which are to be sent as parameters on any HTTP request. More...
 
StoreParameterCollection SyncParameters [get]
 An object containing properties which are to be sent as parameters on sync request. More...
 
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...
 
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]
 
ProxyCollection ServerProxy [get]
 The Proxy to use for this Store. More...
 
virtual BatchUpdateMode BatchUpdateMode [get, set]
 Sets the updating behavior based on batch synchronization. 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. 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...
 
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...
 
DataGrouper Grouper [get]
 
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...
 
DataSorterCollection Sorters [get]
 The collection of Sorters currently applied to this Store More...
 
virtual bool ShowWarningOnFailure [get, set]
 Show a Window with error message is DirectEvent request fails. More...
 
virtual 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...
 
ModelCollection Model [get]
 
ModelFieldCollection Fields [get]
 An array of fields definition objects More...
 
- Properties inherited from Ext.Net.Observable.Config
ConfigItemCollection CustomConfig [get]
 Collection of custom js config More...
 
MessageBusListeners MessageBusListeners [get]
 
MessageBusDirectEvents MessageBusDirectEvents [get]
 
- Properties inherited from Ext.Net.BaseControl.Config
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. More...
 
virtual bool Disabled [get, set]
 
virtual short TabIndex [get, set]
 
virtual bool IsInForm [get, set]
 
virtual Unit Height [get, set]
 
virtual Unit Width [get, set]
 
virtual string ToolTip [get, set]
 
virtual bool RegisterAllResources [get, set]
 
virtual bool AutoDataBind [get, set]
 
virtual IDMode IDMode [get, set]
 
virtual LazyMode LazyMode [get, set]
 
virtual string Namespace [get, set]
 
List< ClientResourceItemResourceItems [get]
 

Additional Inherited Members

- Public Member Functions inherited from Ext.Net.BaseControl.Config
override string ToString ()
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
new Type GetType ()
 
object ApplyIf (object obj)
 
Apply< T > (object obj)
 
object Apply (object obj)
 
virtual string ToScript ()
 

Detailed Description

Member Function Documentation

◆ operator ClientStore.Builder()

static implicit Ext.Net.ClientStore.Config.operator ClientStore.Builder ( ClientStore.Config  config)
inlinestatic

Property Documentation

◆ DirectEvents

ClientStoreDirectEvents Ext.Net.ClientStore.Config.DirectEvents
get

Server-side Ajax Event Handlers

◆ Listeners

ClientStoreListeners Ext.Net.ClientStore.Config.Listeners
get

Client-side JavaScript Event Handlers

◆ Storage

virtual ClientStoreStorage Ext.Net.ClientStore.Config.Storage
getset

Specify 'local' to use localStorage and 'session' to use sessionStorage.

◆ StorageKey

virtual string Ext.Net.ClientStore.Config.StorageKey
getset

The key to use for saving the content of this store.


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