Ext.Net.AjaxOptions Class Reference

Options to be passed to the request /summary> More...

Inheritance diagram for Ext.Net.AjaxOptions:

Classes
class	Builder
class	Config

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

Properties
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...
int	Timeout [get, set]
	The timeout in milliseconds to be used for requests. (defaults to 30000) More...
string	Url [get, set]
	The URL to which to send the request, or a function to call which returns a URL string. The scope of the function is specified by the scope option. Defaults to the configured url. More...
string???	UrlProxy [get]
	The default URL to be used for requests to the server if DirectEventType.Request. (defaults to '') More...
virtual HttpMethod	Method [get, set]
bool	IsUpload [get, set]
	Only meaningful when used with the form option. True if the form object is a file upload (will be set automatically if the form was configured with enctype "multipart/form-data"). File uploads are not performed using normal "Ajax" techniques, that is they are not performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the DOM form element temporarily modified to have its target set to refer to a dynamically generated, hidden iframe which is inserted into the document but removed after the return data has been gathered. The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to send the return object, then the Content-Type header must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body. The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a responseText property in order to conform to the requirements of event handlers and callbacks. Be aware that file upload packets are sent with the content type multipart/form and some server technologies (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the packet content. More...
bool	Json [get, set]
bool	Xml [get, set]
string	FormID [get, set]
	The id of the form to submit. If this.ParentForm is not null then this.ParentForm.ClientID is used, else if FormID is empty the Page.Form.ClientID is used, else try to find the form in dom tree hierarchy, otherwise the Url of current page is used. More...
virtual string	FormProxyArg [get]
virtual ParameterCollection??	Headers [get]
	An object containing request headers which are added to each request made by this object. More...
virtual ParameterCollection	Params [get]
virtual string	Callback [get, set]
string	CallbackProxy [get]
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

Options to be passed to the request /summary>

Constructor & Destructor Documentation

AjaxOptions() [1/2]

Ext.Net.AjaxOptions.AjaxOptions ( )

inline

AjaxOptions() [2/2]

Ext.Net.AjaxOptions.AjaxOptions ( Config  config )

inline

Member Function Documentation

operator AjaxOptions()

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

inlinestatic

ToBuilder()

AjaxOptions.Builder Ext.Net.AjaxOptions.ToBuilder ( )

inline

ToNativeBuilder()

override IControlBuilder Ext.Net.AjaxOptions.ToNativeBuilder ( )

inlinevirtual

Reimplemented from Ext.Net.BaseItem.

Property Documentation

Callback

virtual string Ext.Net.AjaxOptions.Callback

getset

CallbackProxy

string Ext.Net.AjaxOptions.CallbackProxy

getprotected

ConfigOptions

override ConfigOptionsCollection Ext.Net.AjaxOptions.ConfigOptions

get

DisableCaching

bool Ext.Net.AjaxOptions.DisableCaching

getset

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

DisableCachingParam

string Ext.Net.AjaxOptions.DisableCachingParam

getset

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

FormID

string Ext.Net.AjaxOptions.FormID

getset

The id of the form to submit. If this.ParentForm is not null then this.ParentForm.ClientID is used, else if FormID is empty the Page.Form.ClientID is used, else try to find the form in dom tree hierarchy, otherwise the Url of current page is used.

FormProxyArg

virtual string Ext.Net.AjaxOptions.FormProxyArg

getprotected

Headers

virtual ParameterCollection?? Ext.Net.AjaxOptions.Headers

get

An object containing request headers which are added to each request made by this object.

IsDefault

override bool Ext.Net.AjaxOptions.IsDefault

get

IsUpload

bool Ext.Net.AjaxOptions.IsUpload

getset

Only meaningful when used with the form option. True if the form object is a file upload (will be set automatically if the form was configured with enctype "multipart/form-data"). File uploads are not performed using normal "Ajax" techniques, that is they are not performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the DOM form element temporarily modified to have its target set to refer to a dynamically generated, hidden iframe which is inserted into the document but removed after the return data has been gathered. The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to send the return object, then the Content-Type header must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body. The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a responseText property in order to conform to the requirements of event handlers and callbacks. Be aware that file upload packets are sent with the content type multipart/form and some server technologies (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the packet content.

summary> JSON data to use as the post. /summary>

Json

bool Ext.Net.AjaxOptions.Json

getset

summary> XML document to use for the post. /summary>

Params

virtual ParameterCollection Ext.Net.AjaxOptions.Params

get

Timeout

int Ext.Net.AjaxOptions.Timeout

getset

The timeout in milliseconds to be used for requests. (defaults to 30000)

Url

string Ext.Net.AjaxOptions.Url

getset

The URL to which to send the request, or a function to call which returns a URL string. The scope of the function is specified by the scope option. Defaults to the configured url.

UrlProxy

string??? Ext.Net.AjaxOptions.UrlProxy

getprotected

The default URL to be used for requests to the server if DirectEventType.Request. (defaults to '')

summary> The HTTP method to use for the request. Defaults to the configured method, or if no method was configured, "GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that the method name is case-sensitive and should be all caps. /summary>

---

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

• AjaxOptions.cs
• AjaxOptionsConfigOptions.cs
• AjaxOptionsBuilder.cs
• AjaxOptionsConfig.cs