Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.ComponentLoader Class Reference

A class used to load remote content to a component. In general this class will not be instanced directly, rather a loader configuration will be passed to the constructor of the Ext.AbstractComponent More...

Inheritance diagram for Ext.Net.ComponentLoader:
Ext.Net.Observable Ext.Net.BaseControl Ext.Net.ILazyItems Ext.Net.IXObject Ext.Net.IBase

Classes

class  Builder
 
class  Config
 

Public Member Functions

 ComponentLoader ()
 
virtual void UpdateParams ()
 
virtual void Abort ()
 Aborts the active load request More...
 
override void Destroy ()
 Destroys the loader. Any active requests will be aborted. More...
 
virtual void LoadContent ()
 Load new data from the server. More...
 
virtual void LoadContent (bool serialize)
 Load new data from the server. More...
 
virtual void LoadContent (object options)
 
virtual void SetTarget (string targetId)
 Set a {Ext.AbstractComponent} as the target of this loader. Note that if the target is changed, any active requests will be aborted. More...
 
ComponentLoader.Builder ToBuilder ()
 
override IControlBuilder ToNativeBuilder ()
 
 ComponentLoader (Config config)
 
- Public Member Functions inherited from Ext.Net.Observable
virtual void AddListener (string eventName, JFunction fn)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, JFunction fn, string scope)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, JFunction fn, string scope, HandlerConfig options)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, string fn)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, string fn, string scope)
 Appends an event handler to this component More...
 
virtual void AddListener (string eventName, string fn, string scope, HandlerConfig options)
 Appends an event handler to this component More...
 
virtual void AddManagedListener (string item, string eventName, string fn, string scope, HandlerConfig options)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void AddManagedListener (string item, string eventName, string fn, string scope)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void AddManagedListener (string item, string eventName, string fn)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void ClearListeners ()
 Removes all listeners for this object including the managed listeners More...
 
virtual void ClearManagedListeners ()
 Removes all managed listeners for this object. More...
 
virtual void EnableBubble (params string[] events)
 Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class. This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.AbstractComponent-getBubbleTarget. The default implementation in Ext.AbstractComponent returns the AbstractComponent's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. More...
 
virtual void FireEvent (string eventName, params object[] args)
 Fires the specified event with the passed parameters (minus the event name) More...
 
virtual void FireEventedAction (string eventName, object[] args, string fn)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, string fn, string scope)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, string fn, string scope, object[] fnArgs)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, JFunction fn)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, JFunction fn, string scope)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void FireEventedAction (string eventName, object[] args, JFunction fn, string scope, object[] fnArgs)
 Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow. By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events. More...
 
virtual void On (string eventName, string fn)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, string fn, string scope)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, string fn, string scope, HandlerConfig options)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, JFunction fn)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, JFunction fn, string scope)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, JFunction fn, string scope, HandlerConfig options)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void RelayEvents (string origin, string[] events)
 Relays selected events from the specified Observable as if the events were fired by this. More...
 
virtual void RemoveListener (string eventName, string fn)
 Removes an event handler. More...
 
virtual void RemoveListener (string eventName, string fn, string scope)
 Removes an event handler. More...
 
virtual void RemoveManagedListener (string item, string eventName, string fn)
 Removes listeners that were added by the mon method. More...
 
virtual void RemoveManagedListener (string item, string eventName, string fn, string scope)
 Removes listeners that were added by the mon method. More...
 
virtual void ResumeEvents ()
 Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now. More...
 
virtual void SuspendEvents (bool queueSuspended)
 Suspend the firing of all events. (see resumeEvents) More...
 
virtual void SuspendEvents ()
 Suspend the firing of all events. (see resumeEvents) More...
 
virtual void SuspendEvent (string name)
 Suspends firing of the named event(s). More...
 
virtual void ResumeEvent (string name)
 Resumes firing of the named event(s). More...
 
virtual void RemoveDirectListener (string name)
 
virtual void Un (string eventName, string fn)
 Removes a listener (shorthand for removeListener) More...
 
virtual void Un (string eventName, string fn, string scope)
 Removes a listener (shorthand for removeListener) More...
 
virtual void Mon (Element el, string eventName, JFunction fn)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Observable el, string eventName, JFunction fn)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Element el, string eventName, JFunction fn, string scope)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Observable el, string eventName, JFunction fn, string scope)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Element el, string eventName, string fn, string scope, HandlerConfig options)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mon (Observable el, string eventName, string fn, string scope, HandlerConfig options)
 Adds listeners to any Observable object (or Element) which are automatically removed when this AbstractComponent is destroyed. More...
 
virtual void Mun (Element el, string eventName, string fn)
 Removes listeners that were added by the mon method. More...
 
virtual void Mun (Observable el, string eventName, string fn)
 Removes listeners that were added by the mon method. More...
 
virtual void Mun (Element el, string eventName, string fn, string scope)
 Removes listeners that were added by the mon method. More...
 
virtual void Mun (Observable el, string eventName, string fn, string scope)
 Removes listeners that were added by the mon method. More...
 
delegate void OnBeforeClientInitializedHandler (Observable sender)
 
delegate void OnAfterClientInitializedHandler (Observable sender)
 
- Public Member Functions inherited from Ext.Net.BaseControl
virtual bool HasExplicitValue (string name)
 
virtual T ToBuilder< T > ()
 
Apply< T > (IApply config)
 
object Apply (IApply config)
 
BaseControl Apply (object from, bool ignoreDefaultValues)
 
BaseControl Apply (object from)
 
virtual bool HasLayout ()
 
virtual bool HasContent ()
 
virtual string ResolveUrlLink (string url)
 
bool IsInHierarchy (params Type[] types)
 
GetParentByLevel< T > (int level)
 
virtual string DefineInstance ()
 
virtual string DefineInstance (string config)
 
virtual string DefineInstance (string instanceOf, string config)
 
virtual string ToConfig ()
 
virtual string ToConfig (LazyMode mode)
 
virtual string ToConfig (LazyMode mode, bool registerResourcesInManager)
 
virtual string ToScript (bool selfRendering)
 
virtual string ToScript ()
 
string ToScript (RenderMode mode, string element)
 
string ToScript (RenderMode mode, string element, bool selfRendering)
 
string ToScript (RenderMode mode, string element, int index)
 
string ToScript (RenderMode mode, string element, int index, bool selfRendering)
 
string ToScript (RenderMode mode, string element, int? index, bool? selfRendering, bool forceResources, string method, bool forceLazy, bool clearContainer)
 
virtual void AddScript (string script)
 Adds the script to be be called on the client. More...
 
virtual void AddScript (string template, params object[] args)
 Adds the script to be be called on the client. The script is formatted using the template and args. More...
 
virtual void Set (string name, object value)
 
virtual void Set (ScriptPosition position, string name, object value)
 
virtual void Call (string name)
 
virtual void Call (string name, params object[] args)
 
virtual void Call (string name, string[] arg)
 Calls the JavaScript function on the Control with a string[] parameter More...
 
virtual void Call (ScriptPosition mode, string name, params object[] args)
 
virtual string SelfRender ()
 
virtual void AddBeforeClientInitScript (string script)
 Adds the script directly before the ClientInitScript. More...
 
virtual void AddAfterClientInitScript (string script)
 Adds the script directly after the ClientInitScript. More...
 
override void RenderBeginTag (HtmlTextWriter writer)
 
virtual void Render (bool selfRendering)
 
virtual void Render (Control control)
 
virtual void Render ()
 
virtual void Render (string element, RenderMode mode)
 
virtual void Render (string element, int index, RenderMode mode)
 
virtual void Render (Control control, RenderMode mode)
 
virtual void Render (Control control, int index, RenderMode mode)
 
virtual void Render (string element, RenderMode mode, bool selfRendering)
 
virtual void Render (string element, int index, RenderMode mode, bool selfRendering)
 
virtual void Render (RenderMode mode, string element, int? index, bool? selfRendering, bool forceResources, string method, bool forceLazy, bool clearContainer)
 
virtual void Render (Control control, RenderMode mode, bool selfRendering)
 
virtual void Render (Control control, int index, RenderMode mode, bool selfRendering)
 
virtual void AddTo (string element)
 
virtual void AddTo (Control control)
 
virtual void AddTo (string element, bool selfRendering)
 
virtual void AddTo (Control control, bool selfRendering)
 
virtual void InsertTo (int index, string element)
 
virtual void InsertTo (int index, Control control)
 
virtual void InsertTo (int index, string element, bool selfRendering)
 
virtual void InsertTo (int index, Control control, bool selfRendering)
 
virtual void Update ()
 
virtual bool SuspendScripting ()
 
virtual void ResumeScripting (bool oldValue)
 
virtual void ResumeScripting ()
 
List< T > GetCustomResources< T > ()
 
virtual void SetResources ()
 
List< ClientStyleItemGetStyles ()
 
List< ClientStyleItemGetThemes ()
 
List< ClientScriptItemGetScripts ()
 
string GetGeneratedScripts ()
 Get generated and added javascript methods calling More...
 
virtual bool HasOwnState (string name)
 
virtual void SetControlFor (ModelMetadata meta)
 

Static Public Member Functions

static void Render (AbstractComponent component)
 
static void Render (AbstractComponent component, bool registerResources)
 
static string ToConfig (AbstractComponent component)
 
static string ToConfig (AbstractComponent component, bool registerResources)
 
static void Render (IEnumerable< AbstractComponent > components)
 
static void Render (IEnumerable< AbstractComponent > components, bool registerResources)
 
static void Render (IEnumerable< AbstractComponent > components, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender)
 
static void Render (IEnumerable< AbstractComponent > components, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender, bool registerResources)
 
static string ToConfig (IEnumerable< AbstractComponent > components)
 
static string ToConfig (IEnumerable< AbstractComponent > components, bool registerResources)
 
static string ToConfig (IEnumerable< AbstractComponent > components, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender)
 
static string ToConfig (IEnumerable< AbstractComponent > components, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender, bool registerResources)
 
static void Render (string path)
 
static void Render (string path, bool registerResources)
 
static void Render (string path, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender)
 
static void Render (string path, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender, bool registerResources)
 
static string ToConfig (string path)
 
static string ToConfig (string path, bool registerResources)
 
static string ToConfig (string path, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender)
 
static string ToConfig (string path, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender, bool registerResources)
 
static void Render (string path, string userControlId)
 
static void Render (string path, string userControlId, bool registerResources)
 
static void Render (string path, string userControlId, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender)
 
static void Render (string path, string userControlId, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender, bool registerResources)
 
static string ToConfig (string path, string userControlId)
 
static string ToConfig (string path, string userControlId, bool registerResources)
 
static string ToConfig (string path, string userControlId, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender)
 
static string ToConfig (string path, string userControlId, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender, bool registerResources)
 
static void Render (UserControl userControl)
 
static void Render (UserControl userControl, bool registerResources)
 
static void Render (UserControl userControl, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender)
 
static void Render (UserControl userControl, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender, bool registerResources)
 
static string ToConfig (UserControl userControl)
 
static string ToConfig (UserControl userControl, bool registerResources)
 
static string ToConfig (UserControl userControl, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender)
 
static string ToConfig (UserControl userControl, Ext.Net.UserControlLoader.ComponentAddedEventHandler componentPreRender, bool registerResources)
 
static string AttachResources (InsertOrderedDictionary< string, string > scripts, InsertOrderedDictionary< string, string > styles, List< string > nameSpaces, string config)
 
static implicit operator ComponentLoader (ComponentLoader.Config config)
 
- Static Public Member Functions inherited from Ext.Net.BaseControl
static string GenerateID ()
 
static object Apply (object to, object from)
 
static object Apply (object to, object from, bool ignoreDefaultValues)
 

Protected Member Functions

override void OnBeforeClientInit (Observable sender)
 
- Protected Member Functions inherited from Ext.Net.Observable
override void OnInit (EventArgs e)
 
virtual void RegisterCustomAttribute (string key, string value)
 
virtual void OnAfterClientInit (Observable sender)
 
virtual void OnBeforeClientInitHandler ()
 
virtual void OnAfterClientInitHandler ()
 
override void OnPreRender (EventArgs e)
 
override void PreRenderAction ()
 
virtual void AfterItemAdd (Observable item)
 
virtual void AfterItemRemove (Observable item)
 
override void SetModelAdditionalValue (KeyValuePair< string, object > value)
 
- Protected Member Functions inherited from Ext.Net.BaseControl
virtual string GetNamespace (bool parseDot)
 
virtual string AddNamespaceToID (string id)
 
virtual ContentContainer CreateContainer ()
 
virtual void CheckForceId ()
 
virtual string ParseTarget (string target)
 
Unit UnitPixelTypeCheck (object obj, Unit defaultValue, string propertyName)
 
virtual void CallTemplate (string template)
 
virtual void CallTemplate (string template, string name, params object[] args)
 
virtual void CallTemplate (ScriptPosition position, string template, string name, params object[] args)
 
override void OnInit (EventArgs e)
 
virtual void PagePreLoad (object sender, EventArgs e)
 
virtual void PageLoad (object sender, EventArgs e)
 
virtual void PageLoadComplete (object sender, EventArgs e)
 
override void AddAttributesToRender (HtmlTextWriter writer)
 
virtual void SimpleRender (HtmlTextWriter writer)
 
virtual void RecreateChildControls ()
 
override void CreateChildControls ()
 
override void OnPreRender (EventArgs e)
 
virtual void RenderScript (string script)
 
override void OnDataBinding (EventArgs e)
 
override void Render (HtmlTextWriter writer)
 
virtual bool IsGlobalResourceRegistered (ResourceItem item)
 
virtual string FormatValue (object value, string format)
 
virtual void OnMetadataProcess (ModelMetadata meta, string name, ViewDataDictionary viewData, ControllerContext context)
 
virtual void SetModelValidationRule (ModelClientValidationRule rule)
 
virtual void SetModelValue (object value, ModelMetadata meta)
 

Properties

override string InstanceOf [get]
 
bool DisableCaching [get, set]
 True to add a unique cache-buster param to GET requests. (defaults to true) More...
 
string DisableCachingParam [get, set]
 Change the parameter which is sent went disabling caching through a cache buster. Defaults to '_dc' More...
 
virtual AjaxOptions AjaxOptions [get, set]
 Any additional options to be passed to the request, for example timeout or headers. More...
 
virtual bool PassParentSize [get, set]
 
virtual string TriggerEvent [get, set]
 Event which triggers loading process. Default value is render More...
 
virtual string TriggerControl [get, set]
 TriggerEvent's control More...
 
virtual bool ReloadOnEvent [get, set]
 Reload content on each show event. More...
 
virtual bool RemoveD [get, set]
 
virtual bool MonitorComplete [get, set]
 True to monitor complete state of the iframe instead load event using. More...
 
virtual string Callback [get, set]
 
string CallbackProxy [get]
 
virtual bool AutoLoad [get, set]
 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 ParameterCollection?? BaseParams [get]
 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 string Failure [get, set]
 A function to be called when a load request fails. More...
 
virtual string FailureProxy [get]
 
virtual LoadMask?? LoadMask [get]
 True or a Ext.LoadMask configuration to enable masking during loading. Defaults to false. More...
 
virtual ParameterCollection?? Params [get]
 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 string ParamsProxy [get]
 
virtual bool Scripts [get, set]
 True to parse any inline script tags in the response. More...
 
virtual bool RemoveAll [get, set]
 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 ? LoadModeMode [get, set]
 The type of content that is to be loaded into, which can be one of 3 types More...
 
virtual string ParentRef [get, set]
 It is only applicable with Mode="Frame". If ParentRef is a non-empty string, when Ext.NET tries (if the iframe doesn't restrict access) to save a reference to the parent Ext.NET control that loads the iframe as a global variable. For example, setting ParentRef="parentExtNetControl" means that inside the iframe page you should be able to access the Ext.NET parent control by "window.parentExtNetControl" reference. Again only if the iframe doesn't restrict access. If you set ParentRef, you should ensure that the same global variable name is not used inside the iframe. It will be overridden and it is under the developer's responsibility who uses the ParentRef property. More...
 
virtual string Renderer [get, set]
 The function which handles the response The function must return false if loading is not successful. More...
 
virtual string? RendererProxy [get]
 
virtual string RendererScope [get, set]
 The scope to execute the renderer function in. More...
 
virtual string Scope [get, set]
 The scope to execute the success and failure functions in. More...
 
virtual string Success [get, set]
 A function to be called when a load request is successful. More...
 
virtual string SuccessProxy [get]
 
virtual string Target [get, set]
 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 string Url [get, set]
 The url to retrieve the content from. Defaults to null. More...
 
virtual string DirectMethod [get, set]
 The direct method name provides a content for the component More...
 
bool ShowWarningOnFailure [get, set]
 Show warning if request fail. More...
 
ComponentLoaderListeners?? Listeners [get]
 Client-side JavaScript Event Handlers More...
 
override string CallID [get]
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.Observable
virtual List< Observable >?? LazyItems [get]
 
virtual bool SingleItemMode [get]
 
virtual ConfigItemCollection?? CustomConfig [get]
 Collection of custom js config More...
 
DynamicConfigDictionary ConfigsProxy [get]
 
virtual string DirectEventsKey [get]
 
MessageBusListeners MessageBusListeners [get]
 
MessageBusDirectEvents MessageBusDirectEvents [get]
 
virtual string MessageBusListenersProxy [get]
 
virtual string MessageBusDirectEventsProxy [get]
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.BaseControl
string ProductName [get]
 The product name More...
 
virtual string Version [get]
 The Version number of this build More...
 
string DynamicID [get]
 
override string ID [get, set]
 The unique id of this component instance (defaults to an auto-assigned id). Components created with an id may be accessed globally using Ext.getCmp. You can use the itemId config, and ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The Container class contains shortcut methods to query its descendant Components by selector. Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent. Note: to avoid complications imposed by a unique id also see itemId. Note: to access the container of a AbstractComponent see ownerCt. More...
 
override string ClientID [get]
 
virtual string ItemID [get, set]
 An itemId can be used as an alternative way to get a reference to a component when no object reference is available. Instead of using an id with Ext.getCmp, use itemId with Ext.container.Container.getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the itemId is scoped locally to the container – avoiding potential conflicts with Ext.ComponentMgr which requires a unique id More...
 
virtual string???? ConfigID [get]
 
virtual string BaseClientID [get]
 The base .ClientID property derived from .NET Framework More...
 
virtual string ConfigIDProxy [get]
 
bool HasOwnIDMode [get]
 
virtual IDMode IDMode [get, set]
 Options for controlling how the .ClientID property is rendered in the client. More...
 
virtual bool StopIDModeInheritance [get, set]
 
virtual bool StopLazyModeInheritance [get, set]
 
virtual LazyModeLazyMode [get, set]
 Options for controlling how the lazy control is instantiated in the client. More...
 
bool HasOwnNamespace [get]
 
virtual string ClientNamespace [get]
 
virtual string Namespace [get, set]
 
virtual string? ClientNamespaceProxy [get]
 
virtual string??? InitialConfig [get]
 This AbstractComponent's initial configuration specification. Read-only. More...
 
virtual bool AutoDataBind [get, set]
 
virtual FactoryConfig Factory [get, set]
 
virtual string FactoryAlias [get, set]
 
virtual string FactoryInstance [get, set]
 
virtual bool TemplateWidget [get, set]
 
virtual string TemplateWidgetFnName [get, set]
 
virtual ConfigOptionsCollection ConfigOptions [get]
 
virtual ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
virtual DefaultValueMode DefaultValueMode [get, set]
 
virtual bool RemoveContainer [get]
 
virtual bool IsMVC [get]
 
static ClientScriptItem UXScriptItem [get]
 
static ClientStyleItem UXStyleItem [get]
 
virtual bool IsDebugging [get]
 
virtual bool IsAjaxRequestInitiator [get]
 
virtual bool IsDefault [get]
 Does this object currently represent it's default state. More...
 
virtual bool IsLazy [get]
 
virtual string? ContainerID [get]
 
virtual string ContainerStyle [get]
 
virtual bool IsInHead [get]
 
virtual bool IsInForm [get]
 
virtual string ClientForm [get]
 
virtual System.Web.UI.HtmlControls.HtmlForm ParentForm [get]
 
virtual AbstractComponent ParentComponent [get]
 
virtual BaseControl ParentWebControl [get]
 
virtual string InstanceOf [get]
 
virtual string AliasPrefix [get]
 
virtual string? ClassName [get]
 
virtual string CallID [get]
 
virtual bool IsGeneratedID [get]
 
bool IsDynamic [get, set]
 Set to true if a control is meant to be dynamically rendered. In absolutely most cases, this is set to true automatically if needed and originally the property was internal. Though, in some very specific and edge cases a developer might need to set it to true by his own. Setting it to true you should be absolutelly sure it is required. For example, if it is recommended by Ext.NET support team. Also it can be changed only to true, but not backwards. Defaults to false. More...
 
virtual bool ContentUpdated [get, set]
 
string BeforeScript [get]
 
string AfterScript [get]
 
virtual AbstractComponent ParentComponentNotLazyOrDynamic [get]
 
virtual bool RenderTags [get]
 
bool RegisterAllResources [get, set]
 
override string ToolTip [get, set]
 
override string AccessKey [get, set]
 
override Color BackColor [get, set]
 
override Color BorderColor [get, set]
 
override System.Web.UI.WebControls.BorderStyle BorderStyle [get, set]
 
override System.Web.UI.WebControls.Unit BorderWidth [get, set]
 
override string CssClass [get, set]
 
override System.Web.UI.WebControls.FontInfo Font [get]
 
override Color ForeColor [get, set]
 
override Unit Height [get, set]
 
override Unit Width [get, set]
 
virtual string PostBackArgument [get, set]
 
virtual string PostBackConfig [get]
 
virtual bool HasResourceManager [get]
 
virtual ResourceManager ResourceManager [get]
 
virtual List< ResourceItemResources [get]
 
virtual List< ClientResourceItemResourceItems [get]
 
virtual List< ResourceItemGlobalResources [get]
 
virtual string? ClientInitScript [get]
 
virtual bool IsInUpdatePanelRefresh [get]
 
virtual Control MyUpdatePanel [get]
 
System.Web.Mvc.HtmlHelper?? HtmlHelper [get, set]
 
System.Web.Mvc.ViewContext ViewContext [get, set]
 
System.Web.Mvc.ControllerBase Controller [get, set]
 
virtual ViewDataDictionary ViewData [get]
 
virtual ControllerContext ControllerContext [get]
 
virtual string ControlFor [get, set]
 
virtual bool IDFromControlFor [get, set]
 
string FormatControlForValue [get, set]
 
Func< object, object > ConvertControlForValue [get, set]
 
- Properties inherited from Ext.Net.IXObject
ConfigOptionsCollection ConfigOptions [get]
 
ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
DefaultValueMode DefaultValueMode [get, set]
 
- Properties inherited from Ext.Net.ILazyItems
List< ObservableLazyItems [get]
 

Additional Inherited Members

- Events inherited from Ext.Net.Observable
OnBeforeClientInitializedHandler BeforeClientInit
 
OnAfterClientInitializedHandler AfterClientInit
 

Detailed Description

A class used to load remote content to a component. In general this class will not be instanced directly, rather a loader configuration will be passed to the constructor of the Ext.AbstractComponent

Constructor & Destructor Documentation

◆ ComponentLoader() [1/2]

Ext.Net.ComponentLoader.ComponentLoader ( )
inline

◆ ComponentLoader() [2/2]

Ext.Net.ComponentLoader.ComponentLoader ( Config  config)
inline

Member Function Documentation

◆ Abort()

virtual void Ext.Net.ComponentLoader.Abort ( )
inlinevirtual

Aborts the active load request

◆ AttachResources()

static string Ext.Net.ComponentLoader.AttachResources ( InsertOrderedDictionary< string, string >  scripts,
InsertOrderedDictionary< string, string >  styles,
List< string >  nameSpaces,
string  config 
)
inlinestatic

◆ Destroy()

override void Ext.Net.ComponentLoader.Destroy ( )
inlinevirtual

Destroys the loader. Any active requests will be aborted.

Reimplemented from Ext.Net.BaseControl.

◆ LoadContent() [1/2]

virtual void Ext.Net.ComponentLoader.LoadContent ( )
inlinevirtual

Load new data from the server.

◆ LoadContent() [2/2]

virtual void Ext.Net.ComponentLoader.LoadContent ( bool  serialize)
inlinevirtual

Load new data from the server.

summary> Load new data from the server. /summary> param name="options">The options for the request. They can be any configuration option that can be specified for the class, with the exception of the target option. Note that any options passed to the method will override any class defaults.

◆ OnBeforeClientInit()

override void Ext.Net.ComponentLoader.OnBeforeClientInit ( Observable  sender)
inlineprotectedvirtual

Reimplemented from Ext.Net.Observable.

◆ operator ComponentLoader()

static implicit Ext.Net.ComponentLoader.operator ComponentLoader ( ComponentLoader.Config  config)
inlinestatic

◆ Render() [1/18]

static void Ext.Net.ComponentLoader.Render ( AbstractComponent  component)
inlinestatic

◆ Render() [2/18]

static void Ext.Net.ComponentLoader.Render ( AbstractComponent  component,
bool  registerResources 
)
inlinestatic

◆ Render() [3/18]

static void Ext.Net.ComponentLoader.Render ( IEnumerable< AbstractComponent components)
inlinestatic

◆ Render() [4/18]

static void Ext.Net.ComponentLoader.Render ( IEnumerable< AbstractComponent components,
bool  registerResources 
)
inlinestatic

◆ Render() [5/18]

static void Ext.Net.ComponentLoader.Render ( IEnumerable< AbstractComponent components,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender 
)
inlinestatic

◆ Render() [6/18]

static void Ext.Net.ComponentLoader.Render ( IEnumerable< AbstractComponent components,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender,
bool  registerResources 
)
inlinestatic

◆ Render() [7/18]

static void Ext.Net.ComponentLoader.Render ( string  path)
inlinestatic

◆ Render() [8/18]

static void Ext.Net.ComponentLoader.Render ( string  path,
bool  registerResources 
)
inlinestatic

◆ Render() [9/18]

static void Ext.Net.ComponentLoader.Render ( string  path,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender 
)
inlinestatic

◆ Render() [10/18]

static void Ext.Net.ComponentLoader.Render ( string  path,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender,
bool  registerResources 
)
inlinestatic

◆ Render() [11/18]

static void Ext.Net.ComponentLoader.Render ( string  path,
string  userControlId 
)
inlinestatic

◆ Render() [12/18]

static void Ext.Net.ComponentLoader.Render ( string  path,
string  userControlId,
bool  registerResources 
)
inlinestatic

◆ Render() [13/18]

static void Ext.Net.ComponentLoader.Render ( string  path,
string  userControlId,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender 
)
inlinestatic

◆ Render() [14/18]

static void Ext.Net.ComponentLoader.Render ( string  path,
string  userControlId,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender,
bool  registerResources 
)
inlinestatic

◆ Render() [15/18]

static void Ext.Net.ComponentLoader.Render ( UserControl  userControl)
inlinestatic

◆ Render() [16/18]

static void Ext.Net.ComponentLoader.Render ( UserControl  userControl,
bool  registerResources 
)
inlinestatic

◆ Render() [17/18]

static void Ext.Net.ComponentLoader.Render ( UserControl  userControl,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender 
)
inlinestatic

◆ Render() [18/18]

static void Ext.Net.ComponentLoader.Render ( UserControl  userControl,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender,
bool  registerResources 
)
inlinestatic

◆ SetTarget()

virtual void Ext.Net.ComponentLoader.SetTarget ( string  targetId)
inlinevirtual

Set a {Ext.AbstractComponent} as the target of this loader. Note that if the target is changed, any active requests will be aborted.

Parameters
targetIdThe component to be the target of this loader. If a string is passed it will be looked up via its id.

◆ ToBuilder()

ComponentLoader.Builder Ext.Net.ComponentLoader.ToBuilder ( )
inline

◆ ToConfig() [1/18]

static string Ext.Net.ComponentLoader.ToConfig ( AbstractComponent  component)
inlinestatic

◆ ToConfig() [2/18]

static string Ext.Net.ComponentLoader.ToConfig ( AbstractComponent  component,
bool  registerResources 
)
inlinestatic

◆ ToConfig() [3/18]

static string Ext.Net.ComponentLoader.ToConfig ( IEnumerable< AbstractComponent components)
inlinestatic

◆ ToConfig() [4/18]

static string Ext.Net.ComponentLoader.ToConfig ( IEnumerable< AbstractComponent components,
bool  registerResources 
)
inlinestatic

◆ ToConfig() [5/18]

static string Ext.Net.ComponentLoader.ToConfig ( IEnumerable< AbstractComponent components,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender 
)
inlinestatic

◆ ToConfig() [6/18]

static string Ext.Net.ComponentLoader.ToConfig ( IEnumerable< AbstractComponent components,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender,
bool  registerResources 
)
inlinestatic

◆ ToConfig() [7/18]

static string Ext.Net.ComponentLoader.ToConfig ( string  path)
inlinestatic

◆ ToConfig() [8/18]

static string Ext.Net.ComponentLoader.ToConfig ( string  path,
bool  registerResources 
)
inlinestatic

◆ ToConfig() [9/18]

static string Ext.Net.ComponentLoader.ToConfig ( string  path,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender 
)
inlinestatic

◆ ToConfig() [10/18]

static string Ext.Net.ComponentLoader.ToConfig ( string  path,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender,
bool  registerResources 
)
inlinestatic

◆ ToConfig() [11/18]

static string Ext.Net.ComponentLoader.ToConfig ( string  path,
string  userControlId 
)
inlinestatic

◆ ToConfig() [12/18]

static string Ext.Net.ComponentLoader.ToConfig ( string  path,
string  userControlId,
bool  registerResources 
)
inlinestatic

◆ ToConfig() [13/18]

static string Ext.Net.ComponentLoader.ToConfig ( string  path,
string  userControlId,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender 
)
inlinestatic

◆ ToConfig() [14/18]

static string Ext.Net.ComponentLoader.ToConfig ( string  path,
string  userControlId,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender,
bool  registerResources 
)
inlinestatic

◆ ToConfig() [15/18]

static string Ext.Net.ComponentLoader.ToConfig ( UserControl  userControl)
inlinestatic

◆ ToConfig() [16/18]

static string Ext.Net.ComponentLoader.ToConfig ( UserControl  userControl,
bool  registerResources 
)
inlinestatic

◆ ToConfig() [17/18]

static string Ext.Net.ComponentLoader.ToConfig ( UserControl  userControl,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender 
)
inlinestatic

◆ ToConfig() [18/18]

static string Ext.Net.ComponentLoader.ToConfig ( UserControl  userControl,
Ext.Net.UserControlLoader.ComponentAddedEventHandler  componentPreRender,
bool  registerResources 
)
inlinestatic

◆ ToNativeBuilder()

override IControlBuilder Ext.Net.ComponentLoader.ToNativeBuilder ( )
inlinevirtual

Reimplemented from Ext.Net.BaseControl.

◆ UpdateParams()

virtual void Ext.Net.ComponentLoader.UpdateParams ( )
inlinevirtual

Property Documentation

◆ AjaxOptions

virtual AjaxOptions Ext.Net.ComponentLoader.AjaxOptions
getset

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

◆ AutoLoad

virtual bool Ext.Net.ComponentLoader.AutoLoad
getset

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 ParameterCollection?? Ext.Net.ComponentLoader.BaseParams
get

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

◆ Callback

virtual string Ext.Net.ComponentLoader.Callback
getset

◆ CallbackProxy

string Ext.Net.ComponentLoader.CallbackProxy
getprotected

◆ CallID

override string Ext.Net.ComponentLoader.CallID
get

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.ComponentLoader.ConfigOptions
get

◆ DirectMethod

virtual string Ext.Net.ComponentLoader.DirectMethod
getset

The direct method name provides a content for the component

◆ DisableCaching

bool Ext.Net.ComponentLoader.DisableCaching
getset

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

◆ DisableCachingParam

string Ext.Net.ComponentLoader.DisableCachingParam
getset

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

◆ Failure

virtual string Ext.Net.ComponentLoader.Failure
getset

A function to be called when a load request fails.

◆ FailureProxy

virtual string Ext.Net.ComponentLoader.FailureProxy
getprotected

◆ InstanceOf

override string Ext.Net.ComponentLoader.InstanceOf
get

◆ Listeners

ComponentLoaderListeners?? Ext.Net.ComponentLoader.Listeners
get

Client-side JavaScript Event Handlers

◆ LoadMask

virtual LoadMask?? Ext.Net.ComponentLoader.LoadMask
get

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

◆ Mode

virtual ? LoadMode? Ext.Net.ComponentLoader.Mode
getset

The type of content that is to be loaded into, which can be one of 3 types

◆ MonitorComplete

virtual bool Ext.Net.ComponentLoader.MonitorComplete
getset

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

◆ Params

virtual ParameterCollection?? Ext.Net.ComponentLoader.Params
get

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

◆ ParamsProxy

virtual string Ext.Net.ComponentLoader.ParamsProxy
getprotected

◆ ParentRef

virtual string Ext.Net.ComponentLoader.ParentRef
getset

It is only applicable with Mode="Frame". If ParentRef is a non-empty string, when Ext.NET tries (if the iframe doesn't restrict access) to save a reference to the parent Ext.NET control that loads the iframe as a global variable. For example, setting ParentRef="parentExtNetControl" means that inside the iframe page you should be able to access the Ext.NET parent control by "window.parentExtNetControl" reference. Again only if the iframe doesn't restrict access. If you set ParentRef, you should ensure that the same global variable name is not used inside the iframe. It will be overridden and it is under the developer's responsibility who uses the ParentRef property.

◆ PassParentSize

virtual bool Ext.Net.ComponentLoader.PassParentSize
getset

◆ ReloadOnEvent

virtual bool Ext.Net.ComponentLoader.ReloadOnEvent
getset

Reload content on each show event.

◆ RemoveAll

virtual bool Ext.Net.ComponentLoader.RemoveAll
getset

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 bool Ext.Net.ComponentLoader.RemoveD
getset

◆ Renderer

virtual string Ext.Net.ComponentLoader.Renderer
getset

The function which handles the response The function must return false if loading is not successful.

◆ RendererProxy

virtual string? Ext.Net.ComponentLoader.RendererProxy
getprotected

◆ RendererScope

virtual string Ext.Net.ComponentLoader.RendererScope
getset

The scope to execute the renderer function in.

◆ Scope

virtual string Ext.Net.ComponentLoader.Scope
getset

The scope to execute the success and failure functions in.

◆ Scripts

virtual bool Ext.Net.ComponentLoader.Scripts
getset

True to parse any inline script tags in the response.

◆ ShowWarningOnFailure

bool Ext.Net.ComponentLoader.ShowWarningOnFailure
getset

Show warning if request fail.

◆ Success

virtual string Ext.Net.ComponentLoader.Success
getset

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

◆ SuccessProxy

virtual string Ext.Net.ComponentLoader.SuccessProxy
getprotected

◆ Target

virtual string Ext.Net.ComponentLoader.Target
getset

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 string Ext.Net.ComponentLoader.TriggerControl
getset

TriggerEvent's control

◆ TriggerEvent

virtual string Ext.Net.ComponentLoader.TriggerEvent
getset

Event which triggers loading process. Default value is render

◆ Url

virtual string Ext.Net.ComponentLoader.Url
getset

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


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