Ext.Net.Task.Builder< TTask, TBuilder > Class Template Reference

More...

Inheritance diagram for Ext.Net.Task.Builder< TTask, TBuilder >:

Public Member Functions
	Builder (TTask component)
virtual TBuilder	TaskID (string taskID)
	(optional) The TaskID. More...
virtual TBuilder	AutoRun (bool autoRun)
	True to auto run task (defaults to false). More...
virtual TBuilder	WaitPreviousRequest (bool waitPreviousRequest)
	True to wait previous request. More...
virtual TBuilder	Interval (int interval)
	The frequency in milliseconds with which the task should be executed (defaults to 1000) More...
virtual TBuilder	Args (string[] args)
	(optional) An array of arguments to be passed to the function specified by run More...
virtual TBuilder	Scope (string scope)
	(optional) The scope in which to execute the run function. More...
virtual TBuilder	Duration (int duration)
	(optional) The length of time in milliseconds to execute the task before stopping automatically (defaults to indefinite). More...
virtual TBuilder	Repeat (int repeat)
	(optional) The number of times to execute the task before stopping automatically (defaults to indefinite). More...
virtual TBuilder	OnStart (string onStart)
virtual TBuilder	OnStop (string onStop)
virtual TBuilder	Listeners (Action< TaskListeners > action)
	Client-side JavaScript Event Handlers More...
virtual TBuilder	DirectEvents (Action< TaskDirectEvents > action)
	Server-side DirectEventHandlers More...
	Builder ()
	Builder (Task component)
	Builder (Task.Config config)
Public Member Functions inherited from Ext.Net.BaseItem.Builder< TTask, TBuilder >
	Builder (TItem item)
virtual TItem	ToComponent ()
	Get the instance of the underlying StateManagedItem. More...
virtual TBuilder	CustomConfig (Action< ConfigItemCollection > action)
	Collection of custom js config More...

Static Public Member Functions
static implicit	operator Builder (Task component)
Static Public Member Functions inherited from Ext.Net.BaseItem.Builder< TTask, TBuilder >
static implicit	operator TItem (BaseItem.Builder< TItem, TBuilder > builder)
	Implicit conversion of a TItem object directly into a TComponent. More...

Additional Inherited Members
Protected Attributes inherited from Ext.Net.BaseItem.Builder< TTask, TBuilder >
TItem	item

Detailed Description

Type Constraints

TTask	:	Task
TBuilder	:	Builder
TBuilder	:	TTask
TBuilder	:	TBuilder

Constructor & Destructor Documentation

Builder() [1/4]

Ext.Net.Task.Builder< TTask, TBuilder >.Builder ( TTask  component )

inline

Builder() [2/4]

Ext.Net.Task.Builder< TTask, TBuilder >.Builder ( )

inline

Builder() [3/4]

Ext.Net.Task.Builder< TTask, TBuilder >.Builder ( Task  component )

inline

Builder() [4/4]

Ext.Net.Task.Builder< TTask, TBuilder >.Builder ( Task.Config  config )

inline

Member Function Documentation

Args()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.Args ( string[]  args )

inlinevirtual

(optional) An array of arguments to be passed to the function specified by run

AutoRun()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.AutoRun ( bool  autoRun )

inlinevirtual

True to auto run task (defaults to false).

DirectEvents()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.DirectEvents ( Action< TaskDirectEvents >  action )

inlinevirtual

Server-side DirectEventHandlers

Parameters

action

The action delegate

Returns

An instance of TBuilder

Duration()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.Duration ( int  duration )

inlinevirtual

(optional) The length of time in milliseconds to execute the task before stopping automatically (defaults to indefinite).

Interval()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.Interval ( int  interval )

inlinevirtual

The frequency in milliseconds with which the task should be executed (defaults to 1000)

Listeners()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.Listeners ( Action< TaskListeners >  action )

inlinevirtual

Client-side JavaScript Event Handlers

Parameters

action

The action delegate

Returns

An instance of TBuilder

OnStart()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.OnStart ( string  onStart )

inlinevirtual

OnStop()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.OnStop ( string  onStop )

inlinevirtual

operator Builder()

static implicit Ext.Net.Task.Builder< TTask, TBuilder >.operator Builder ( Task  component )

inlinestatic

Repeat()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.Repeat ( int  repeat )

inlinevirtual

(optional) The number of times to execute the task before stopping automatically (defaults to indefinite).

Scope()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.Scope ( string  scope )

inlinevirtual

(optional) The scope in which to execute the run function.

TaskID()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.TaskID ( string  taskID )

inlinevirtual

(optional) The TaskID.

WaitPreviousRequest()

virtual TBuilder Ext.Net.Task.Builder< TTask, TBuilder >.WaitPreviousRequest ( bool  waitPreviousRequest )

inlinevirtual

True to wait previous request.

---

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

• TaskBuilder.cs