Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder > Class Template Reference

More...

Inheritance diagram for Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >:
Ext.Net.Observable.Builder< TComponentLoader, TBuilder >

Public Member Functions

 Builder (TComponentLoader component)
 
virtual TBuilder DisableCaching (bool disableCaching)
 True to add a unique cache-buster param to GET requests. (defaults to true) More...
 
virtual TBuilder DisableCachingParam (string disableCachingParam)
 Change the parameter which is sent went disabling caching through a cache buster. Defaults to '_dc' More...
 
virtual TBuilder AjaxOptions (AjaxOptions ajaxOptions)
 Any additional options to be passed to the request, for example timeout or headers. More...
 
virtual TBuilder PassParentSize (bool passParentSize)
 
virtual TBuilder TriggerEvent (string triggerEvent)
 Event which triggers loading process. Default value is render More...
 
virtual TBuilder TriggerControl (string triggerControl)
 TriggerEvent's control More...
 
virtual TBuilder ReloadOnEvent (bool reloadOnEvent)
 Reload content on each show event. More...
 
virtual TBuilder RemoveD (bool removeD)
 
virtual TBuilder MonitorComplete (bool monitorComplete)
 True to monitor complete state of the iframe instead load event using. More...
 
virtual TBuilder Callback (string callback)
 
virtual TBuilder AutoLoad (bool autoLoad)
 True to have the loader make a request as soon as it is created. Defaults to true. This argument can also be a set of options that will be passed to load is called. More...
 
virtual TBuilder BaseParams (Action< ParameterCollection > action)
 Params that will be attached to every request. These parameters will not be overridden by any params in the load options. Defaults to null. More...
 
virtual TBuilder Failure (string failure)
 A function to be called when a load request fails. More...
 
virtual TBuilder LoadMask (Action< LoadMask > action)
 True or a Ext.LoadMask configuration to enable masking during loading. Defaults to false. More...
 
virtual TBuilder Params (Action< ParameterCollection > action)
 Any params to be attached to the Ajax request. These parameters will be overridden by any params in the load options. Defaults to null. More...
 
virtual TBuilder Scripts (bool scripts)
 True to parse any inline script tags in the response. More...
 
virtual TBuilder RemoveAll (bool removeAll)
 True to remove all existing components when a load completes. This option is only takes effect when the renderer option is set to component. Defaults to false. More...
 
virtual TBuilder Mode (LoadMode? mode)
 The type of content that is to be loaded into, which can be one of 4 types. Html|Data|Component|Frame More...
 
virtual TBuilder ParentRef (string parentRef)
 
virtual TBuilder Renderer (string renderer)
 The function which handles the response More...
 
virtual TBuilder RendererScope (string rendererScope)
 The scope to execute the renderer function in. More...
 
virtual TBuilder Scope (string scope)
 The scope to execute the success and failure functions in. More...
 
virtual TBuilder Success (string success)
 A function to be called when a load request is successful. More...
 
virtual TBuilder Target (string target)
 The target Ext.AbstractComponent for the loader. Defaults to null. If a string is passed it will be looked up via the id. More...
 
virtual TBuilder Url (string url)
 The url to retrieve the content from. Defaults to null. More...
 
virtual TBuilder DirectMethod (string directMethod)
 The direct method name provides a content for the component More...
 
virtual TBuilder ShowWarningOnFailure (bool showWarningOnFailure)
 Show warning if request fail. More...
 
virtual TBuilder Listeners (Action< ComponentLoaderListeners > action)
 Client-side JavaScript Event Handlers More...
 
 Builder ()
 
 Builder (ComponentLoader component)
 
 Builder (ComponentLoader.Config config)
 
virtual ComponentLoader.Builder Params (object parameters)
 

Static Public Member Functions

static implicit operator Builder (ComponentLoader component)
 

Detailed Description

Type Constraints
TComponentLoader :ComponentLoader 
TBuilder :Builder 
TBuilder :TComponentLoader 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Builder ( TComponentLoader  component)
inline

◆ Builder() [2/4]

Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Builder ( ComponentLoader  component)
inline

◆ Builder() [4/4]

Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Builder ( ComponentLoader.Config  config)
inline

Member Function Documentation

◆ AjaxOptions()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.AjaxOptions ( AjaxOptions  ajaxOptions)
inlinevirtual

Any additional options to be passed to the request, for example timeout or headers.

◆ AutoLoad()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.AutoLoad ( bool  autoLoad)
inlinevirtual

True to have the loader make a request as soon as it is created. Defaults to true. This argument can also be a set of options that will be passed to load is called.

◆ BaseParams()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.BaseParams ( Action< ParameterCollection action)
inlinevirtual

Params that will be attached to every request. These parameters will not be overridden by any params in the load options. Defaults to null.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ Callback()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Callback ( string  callback)
inlinevirtual

◆ DirectMethod()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.DirectMethod ( string  directMethod)
inlinevirtual

The direct method name provides a content for the component

◆ DisableCaching()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.DisableCaching ( bool  disableCaching)
inlinevirtual

True to add a unique cache-buster param to GET requests. (defaults to true)

◆ DisableCachingParam()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.DisableCachingParam ( string  disableCachingParam)
inlinevirtual

Change the parameter which is sent went disabling caching through a cache buster. Defaults to '_dc'

◆ Failure()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Failure ( string  failure)
inlinevirtual

A function to be called when a load request fails.

◆ Listeners()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Listeners ( Action< ComponentLoaderListeners action)
inlinevirtual

Client-side JavaScript Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ LoadMask()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.LoadMask ( Action< LoadMask action)
inlinevirtual

True or a Ext.LoadMask configuration to enable masking during loading. Defaults to false.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ Mode()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Mode ( LoadMode mode)
inlinevirtual

The type of content that is to be loaded into, which can be one of 4 types. Html|Data|Component|Frame

◆ MonitorComplete()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.MonitorComplete ( bool  monitorComplete)
inlinevirtual

True to monitor complete state of the iframe instead load event using.

◆ operator Builder()

static implicit Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.operator Builder ( ComponentLoader  component)
inlinestatic

◆ Params() [1/2]

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Params ( Action< ParameterCollection action)
inlinevirtual

Any params to be attached to the Ajax request. These parameters will be overridden by any params in the load options. Defaults to null.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ Params() [2/2]

virtual ComponentLoader.Builder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Params ( object  parameters)
inlinevirtual

◆ ParentRef()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.ParentRef ( string  parentRef)
inlinevirtual

◆ PassParentSize()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.PassParentSize ( bool  passParentSize)
inlinevirtual

◆ ReloadOnEvent()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.ReloadOnEvent ( bool  reloadOnEvent)
inlinevirtual

Reload content on each show event.

◆ RemoveAll()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.RemoveAll ( bool  removeAll)
inlinevirtual

True to remove all existing components when a load completes. This option is only takes effect when the renderer option is set to component. Defaults to false.

◆ RemoveD()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.RemoveD ( bool  removeD)
inlinevirtual

◆ Renderer()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Renderer ( string  renderer)
inlinevirtual

The function which handles the response

◆ RendererScope()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.RendererScope ( string  rendererScope)
inlinevirtual

The scope to execute the renderer function in.

◆ Scope()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Scope ( string  scope)
inlinevirtual

The scope to execute the success and failure functions in.

◆ Scripts()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Scripts ( bool  scripts)
inlinevirtual

True to parse any inline script tags in the response.

◆ ShowWarningOnFailure()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.ShowWarningOnFailure ( bool  showWarningOnFailure)
inlinevirtual

Show warning if request fail.

◆ Success()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Success ( string  success)
inlinevirtual

A function to be called when a load request is successful.

◆ Target()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Target ( string  target)
inlinevirtual

The target Ext.AbstractComponent for the loader. Defaults to null. If a string is passed it will be looked up via the id.

◆ TriggerControl()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.TriggerControl ( string  triggerControl)
inlinevirtual

TriggerEvent's control

◆ TriggerEvent()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.TriggerEvent ( string  triggerEvent)
inlinevirtual

Event which triggers loading process. Default value is render

◆ Url()

virtual TBuilder Ext.Net.ComponentLoader.Builder< TComponentLoader, TBuilder >.Url ( string  url)
inlinevirtual

The url to retrieve the content from. Defaults to null.


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