Ext.Net.WaitConfig Class Reference

A config object containing any or all of the following properties. If this object is not specified the status will be cleared using the defaults. More...

Inheritance diagram for Ext.Net.WaitConfig:

Public Member Functions
	WaitConfig ()
virtual string	ToJsonString ()
Public Member Functions inherited from Ext.Net.ExtObject
virtual bool	HasExplicitValue (string name)

Properties
virtual int	Duration [get, set]
	The length of time in milliseconds that the progress bar should run before resetting itself (defaults to undefined, in which case it will run indefinitely until reset is called) More...
virtual int	Interval [get, set]
	The length of time in milliseconds between each progress update (defaults to 1000 ms) More...
virtual ? bool	Animate [get, set]
	Whether to animate the transition of the progress bar. If this value is not specified, the default for the class is used. More...
virtual int	Increment [get, set]
	The number of progress update segments to display within the progress bar (defaults to 10). If the bar reaches the end and is still updating, it will automatically wrap back to the beginning. More...
virtual string	Text [get, set]
	Optional text to display in the progress bar element (defaults to ''). More...
virtual string	Fn [get, set]
	A callback function to execute after the progress bar finishes auto-updating. The function will be called with no arguments. This function will be ignored if duration is not specified since in that case the progress bar can only be stopped programmatically, so any required function should be called by the same code after it resets the progress bar. More...
virtual string	Scope [get, set]
	The scope that is passed to the callback function (only applies when duration and fn are both passed). More...
override ConfigOptionsCollection	ConfigOptions [get]
Properties inherited from Ext.Net.ExtObject
virtual ConfigOptionsCollection	ConfigOptions [get]
virtual ConfigOptionsExtraction	ConfigOptionsExtraction [get]
virtual DefaultValueMode	DefaultValueMode [get, set]
Properties inherited from Ext.Net.IXObject
ConfigOptionsCollection	ConfigOptions [get]
ConfigOptionsExtraction	ConfigOptionsExtraction [get]
DefaultValueMode	DefaultValueMode [get, set]

Detailed Description

A config object containing any or all of the following properties. If this object is not specified the status will be cleared using the defaults.

Constructor & Destructor Documentation

WaitConfig()

Ext.Net.WaitConfig.WaitConfig ( )

inline

Member Function Documentation

ToJsonString()

virtual string Ext.Net.WaitConfig.ToJsonString ( )

inlinevirtual

Property Documentation

Animate

virtual ? bool Ext.Net.WaitConfig.Animate

getset

Whether to animate the transition of the progress bar. If this value is not specified, the default for the class is used.

ConfigOptions

override ConfigOptionsCollection Ext.Net.WaitConfig.ConfigOptions

get

Duration

virtual int Ext.Net.WaitConfig.Duration

getset

The length of time in milliseconds that the progress bar should run before resetting itself (defaults to undefined, in which case it will run indefinitely until reset is called)

Fn

virtual string Ext.Net.WaitConfig.Fn

getset

A callback function to execute after the progress bar finishes auto-updating. The function will be called with no arguments. This function will be ignored if duration is not specified since in that case the progress bar can only be stopped programmatically, so any required function should be called by the same code after it resets the progress bar.

Increment

virtual int Ext.Net.WaitConfig.Increment

getset

The number of progress update segments to display within the progress bar (defaults to 10). If the bar reaches the end and is still updating, it will automatically wrap back to the beginning.

Interval

virtual int Ext.Net.WaitConfig.Interval

getset

The length of time in milliseconds between each progress update (defaults to 1000 ms)

Scope

virtual string Ext.Net.WaitConfig.Scope

getset

The scope that is passed to the callback function (only applies when duration and fn are both passed).

Text

virtual string Ext.Net.WaitConfig.Text

getset

Optional text to display in the progress bar element (defaults to '').

---

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

• ProgressBar.WaitConfig.cs
• WaitConfigConfigOptions.cs