Ext.Net.SessionStorageProxy Class Reference

Proxy which uses HTML5 session storage as its data storage/retrieval mechanism. If this proxy is used in a browser where session storage is not supported, the constructor will throw an error. A session storage proxy requires a unique ID which is used as a key in which all record data are stored in the session storage object. More...

Inheritance diagram for Ext.Net.SessionStorageProxy:

Classes
class	Builder
class	Config

Public Member Functions
	SessionStorageProxy ()
SessionStorageProxy.Builder	ToBuilder ()
override IControlBuilder	ToNativeBuilder ()
	SessionStorageProxy (Config config)
Public Member Functions inherited from Ext.Net.WebStorageProxy
virtual void	Clear ()
	Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage object More...
virtual void	SetRecord (object record, string id)
	Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data More...
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 ()
T	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 SessionStorageProxy (SessionStorageProxy.Config config)

Properties
override string	InstanceOf [get]
override string	Type [get]
	Alias More...
override ConfigOptionsCollection	ConfigOptions [get]
Properties inherited from Ext.Net.WebStorageProxy
override string	InstanceOf [get]
virtual string??	StorageID [get, set]
	The unique ID used as the key in which all record data are stored in the local storage object More...
override ConfigOptionsCollection	ConfigOptions [get]
Properties inherited from Ext.Net.AbstractProxy
override string	InstanceOf [get]
abstract string	Type [get]
	Alias More...
virtual bool	BatchActions [get, set]
	True to batch actions of a particular type when synchronizing the store. Defaults to true. More...
virtual string	BatchOrder [get, set]
	Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this to set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy' More...
string	PropertyName [get]
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]
Properties inherited from Ext.Net.IAlias
string	PropertyName [get]

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

Proxy which uses HTML5 session storage as its data storage/retrieval mechanism. If this proxy is used in a browser where session storage is not supported, the constructor will throw an error. A session storage proxy requires a unique ID which is used as a key in which all record data are stored in the session storage object.

It's important to supply this unique ID as it cannot be reliably determined otherwise. If no id is provided but the attached store has a storeId, the storeId will be used. If neither option is presented the proxy will throw an error.

Proxies are almost always used with a store:

new Ext.data.Store({ proxy: { type: 'sessionstorage', id : 'myProxyKey' } }); Alternatively you can instantiate the Proxy directly:

new Ext.data.proxy.SessionStorage({ id : 'myOtherProxyKey' });

Note that session storage is different to local storage (see Ext.data.proxy.LocalStorage) - if a browser session is ended (e.g. by closing the browser) then all data in a SessionStorageProxy are lost. Browser restarts don't affect the Ext.data.proxy.LocalStorage - the data are preserved.

Constructor & Destructor Documentation

SessionStorageProxy() [1/2]

Ext.Net.SessionStorageProxy.SessionStorageProxy ( )

inline

SessionStorageProxy() [2/2]

Ext.Net.SessionStorageProxy.SessionStorageProxy ( Config  config )

inline

Member Function Documentation

operator SessionStorageProxy()

static implicit Ext.Net.SessionStorageProxy.operator SessionStorageProxy ( SessionStorageProxy.Config  config )

inlinestatic

ToBuilder()

SessionStorageProxy.Builder Ext.Net.SessionStorageProxy.ToBuilder ( )

inline

ToNativeBuilder()

override IControlBuilder Ext.Net.SessionStorageProxy.ToNativeBuilder ( )

inlinevirtual

Reimplemented from Ext.Net.BaseItem.

Property Documentation

ConfigOptions

override ConfigOptionsCollection Ext.Net.SessionStorageProxy.ConfigOptions

get

InstanceOf

override string Ext.Net.SessionStorageProxy.InstanceOf

get

Type

override string Ext.Net.SessionStorageProxy.Type

getprotected

Alias

---

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

• SessionStorageProxy.cs
• SessionStorageProxyConfigOptions.cs
• SessionStorageProxyBuilder.cs
• SessionStorageProxyConfig.cs