Ext.Net.LoadMask Class Reference

A simple utility class for generically masking elements while loading data. If the element being masked has an underlying Ext.data.Store, the masking will be automatically synchronized with the store's loading process and the mask element will be cached for reuse. For all other elements, this mask will replace the element's UpdateOptions load indicator and will be destroyed after the initial load. More...

Inheritance diagram for Ext.Net.LoadMask:

Classes
class	Builder
class	Config

Public Member Functions
	LoadMask ()
LoadMask.Builder	ToBuilder ()
override IControlBuilder	ToNativeBuilder ()
	LoadMask (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 ()
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 LoadMask (LoadMask.Config config)

Properties
virtual bool	ShowMask [get, set]
	True to create a single-use mask that is automatically destroyed after loading (useful for page loads), False to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false. More...
virtual string	Msg [get, set]
	The text to display in a centered loading message box. Defaults to: "Loading..." More...
virtual string	MsgCls [get, set]
	The CSS class to apply to the loading message element (defaults to 'x-mask-loading'). More...
virtual string	StoreID [get, set]
	Optional Store to which the mask is bound. The mask is displayed when a load request is issued, and hidden on either load success, or load fail. More...
virtual bool	UseMsg [get, set]
	Whether or not to use a loading message class or simply mask the bound element. Defaults to: true More...
override bool	IsDefault [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]

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

A simple utility class for generically masking elements while loading data. If the element being masked has an underlying Ext.data.Store, the masking will be automatically synchronized with the store's loading process and the mask element will be cached for reuse. For all other elements, this mask will replace the element's UpdateOptions load indicator and will be destroyed after the initial load.

Constructor & Destructor Documentation

LoadMask() [1/2]

Ext.Net.LoadMask.LoadMask ( )

inline

LoadMask() [2/2]

Ext.Net.LoadMask.LoadMask ( Config  config )

inline

Member Function Documentation

operator LoadMask()

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

inlinestatic

ToBuilder()

LoadMask.Builder Ext.Net.LoadMask.ToBuilder ( )

inline

ToNativeBuilder()

override IControlBuilder Ext.Net.LoadMask.ToNativeBuilder ( )

inlinevirtual

Reimplemented from Ext.Net.BaseItem.

Property Documentation

ConfigOptions

override ConfigOptionsCollection Ext.Net.LoadMask.ConfigOptions

get

IsDefault

override bool Ext.Net.LoadMask.IsDefault

get

Msg

virtual string Ext.Net.LoadMask.Msg

getset

The text to display in a centered loading message box. Defaults to: "Loading..."

MsgCls

virtual string Ext.Net.LoadMask.MsgCls

getset

The CSS class to apply to the loading message element (defaults to 'x-mask-loading').

ShowMask

virtual bool Ext.Net.LoadMask.ShowMask

getset

True to create a single-use mask that is automatically destroyed after loading (useful for page loads), False to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false.

StoreID

virtual string Ext.Net.LoadMask.StoreID

getset

Optional Store to which the mask is bound. The mask is displayed when a load request is issued, and hidden on either load success, or load fail.

UseMsg

virtual bool Ext.Net.LoadMask.UseMsg

getset

Whether or not to use a loading message class or simply mask the bound element. Defaults to: true

---

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

• LoadMask.cs
• LoadMaskConfigOptions.cs
• LoadMaskBuilder.cs
• LoadMaskConfig.cs