Ext core utilities and functions. More...

Inheritance diagram for Ext.Net.X:

Static Public Member Functions
static void	On (GlobalListeners events)
	Appends an event handler to this object. More...

static void	Un (GlobalListeners events)
	Removes an event handler. More...

static object	Apply (object obj, object config)
	Copies all the properties of config to obj. More...

static T	Apply< T > (object obj, object config)
	Copies all the properties of config to obj. More...

static void	Defer (string handler, int millis)
	Calls this function after the number of millseconds specified, optionally in a specific scope. More...

static void	Defer (JFunction function, int millis)
	Calls this function after the number of millseconds specified, optionally in a specific scope. More...

static void	Redirect (string url)
	Redirects a client to a new Url. More...

static void	Redirect (string url, string msg)
	Redirects a client to a new Url. More...

static void	Redirect (string url, string msg, string msgCls)
	Redirects a client to a new Url. More...

static void	Reload ()
	Reloads the page by window.location.reload() call More...

static void	Reload (string msg)
	Reloads the page by window.location.reload() call More...

static void	Reload (string msg, string msgCls)
	Reloads the page by window.location.reload() call More...

static void	Toast (string message)
	Display a toast with the specified message on default location of the screen. More...

static void	Toast (string message, string title, ToastAlign align=ToastAlign.Default, string iconCls=null)
	Display a toast with the specified arguments settings on default location of the screen. More...

static void	Toast (Toast component)
	Given an Ext.Net.Toast component, display it on screen. More...

static void	Toast (object componentConfig)
	Given an anonymous object with config options pertaining to a Toast component, display it on screen. More...

static Control	GetCtl (string id)
	Get the Control with the specified id. More...

static T	GetCtl< T > (string id)
	Get the Control with the specified id. More...

static BaseControl	GetCmp (string id)
	Returns a AbstractComponent by id. More...

static T	GetCmp< T > (string id)
	Returns the AbstractComponent by id and sets the .Value related fields by calling if available from the Request. More...

static T	GetCmp< T > (string id, string ns)
	Returns the AbstractComponent by id and sets the .Value related fields by calling if available from the Request. More...

static T	GetCmp< T > (string id, BaseControl.Config config)
	Returns the AbstractComponent by id and sets the .Value related fields by calling if available from the Request. More...

static T	ComponentQuery< T > (string selector)

static T	GetCmp< T > (T component)
	Returns the AbstractComponent and sets the .Value related fields by calling if available from the Request. More...

static T	SetValue< T > (T component, string value)
	Sets the value of the component if the component is a typeof IField. More...

static string	GetValue (string id)
	Given the ID of a form field, returns the raw submmitted form value as a string. Returns 'null' if value can not be found. More...

static Element	Get (Control control)
	Retrieves Ext.Element objects. This method does not retrieve Components. This method retrieves Ext.Element objects which encapsulate DOM elements. Uses simple caching to consistently return the same object. Automatically fixes if an object was recreated with the same id via AJAX or DOM. More...

static Element	Get (object node)
	Retrieves Ext.Element objects. This method does not retrieve Components. This method retrieves Ext.Element objects which encapsulate DOM elements. Uses simple caching to consistently return the same object. Automatically fixes if an object was recreated with the same id via AJAX or DOM. More...

static Element	Fly (object node)
	Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - the dom node can be overwritten by other code. Shorthand of Ext.Element.fly Use this to make one-time references to DOM elements which are not going to be accessed again either by application code, or by Ext's classes. If accessing an element which will be processed regularly, then Ext.get will be more appropriate to take advantage of the caching provided by the Ext.Element class. More...

static Element	Fly (object node, string named)
	Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - the dom node can be overwritten by other code. Shorthand of Ext.Element.fly Use this to make one-time references to DOM elements which are not going to be accessed again either by application code, or by Ext's classes. If accessing an element which will be processed regularly, then Ext.get will be more appropriate to take advantage of the caching provided by the Ext.Element class. More...

static Element	Body ()
	Returns the current document body as an Ext.Element. More...

static Element	Form ()
	Returns the current ASP.NET form as an Ext.Element. More...

static Element	Document ()
	Returns the current HTML document object as an Ext.Element. More...

static Element	Head ()
	Returns the current HTML head object as an Ext.Element. More...

static Element	Window ()
	Returns the current window object as an Ext.dom.Element. Typically used for attaching event listeners to the window. Note: since the window object is not an HTMLElement many of the Ext.dom.Element methods are not applicable and may throw errors if called on the returned Element instance. More...

static Element	Select (string selector, bool unique, string root)
	Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in one statement More...

static Element	Select (string selector, bool unique)
	Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in one statement More...

static Element	Select (string selector)
	Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in one statement More...

static Element	SingleSelect (string selector)
	Selects first element based on the passed CSS selector More...

static Element	SingleSelect (string selector, bool unique)
	Selects first element based on the passed CSS selector More...

static Element	SingleSelect (string selector, bool unique, string root)
	Selects first element based on the passed CSS selector More...

static void	SuspendLayouts ()

static void	ResumeLayouts ()
	Resumes layout activity in the whole framework. More...

static void	ResumeLayouts (bool flush)
	Resumes layout activity in the whole framework. More...

static void	AddScript (string template, params object[] args)

static void	AddScript (string script)

static void	Call (string name)

static void	Call (string name, params object[] args)

static void	Set (string name, object value)

Properties
static bool	IsAjaxRequest `[get]`
	Determines if the current HttpRequest is an Ext.NET Ajax Request. More...

static ResourceManager	ResourceManager `[get]`
	Returns an instance of the current Ext.NET ResourceManager. More...

static Mask??	Mask `[get]`

static MessageBox	Msg `[get]`

static MessageBox??	MessageBox `[get]`

static QuickTips??	QuickTips `[get]`

static WindowManager??	WindowManager `[get]`

static Js??	Js `[get]`

static bool?	ControlsScripting `[get, set]`

static BuilderFactory	Builder `[get]`

Detailed Description

Ext core utilities and functions.

Member Function Documentation

◆ AddScript() [1/2]

static void Ext.Net.X.AddScript ( string script )

inlinestatic

Parameters

script

◆ AddScript() [2/2]

static void Ext.Net.X.AddScript	(	string	template,
		params object[]	args
	)

inlinestatic

Parameters

template
args

◆ Apply()

static object Ext.Net.X.Apply	(	object	obj,
		object	config
	)

inlinestatic

Copies all the properties of config to obj.

Parameters

obj	The receiver of the properties
config	The source of the properties

Returns: obj

◆ Apply< T >()

static T Ext.Net.X.Apply< T >	(	object	obj,
		object	config
	)

inlinestatic

Copies all the properties of config to obj.

Template Parameters

T	The Type of the obj param.

Parameters

obj	The receiver of the properties
config	The source of the properties

Returns: obj as T

Type Constraints

T

:

IComponent

◆ Body()

static Element Ext.Net.X.Body ( )

inlinestatic

Returns the current document body as an Ext.Element.

Returns: Element

◆ Call() [1/2]

static void Ext.Net.X.Call ( string name )

inlinestatic

◆ Call() [2/2]

static void Ext.Net.X.Call	(	string	name,
		params object[]	args
	)

inlinestatic

◆ ComponentQuery< T >()

static T Ext.Net.X.ComponentQuery< T > ( string selector )

inlinestatic

Type Constraints

T	:	BaseControl
T	:	new()

◆ Defer() [1/2]

static void Ext.Net.X.Defer	(	JFunction	function,
		int	millis
	)

inlinestatic

Calls this function after the number of millseconds specified, optionally in a specific scope.

◆ Defer() [2/2]

static void Ext.Net.X.Defer	(	string	handler,
		int	millis
	)

inlinestatic

Calls this function after the number of millseconds specified, optionally in a specific scope.

◆ Document()

static Element Ext.Net.X.Document ( )

inlinestatic

Returns the current HTML document object as an Ext.Element.

Returns: Element

◆ Fly() [1/2]

static Element Ext.Net.X.Fly ( object node )

inlinestatic

Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - the dom node can be overwritten by other code. Shorthand of Ext.Element.fly Use this to make one-time references to DOM elements which are not going to be accessed again either by application code, or by Ext's classes. If accessing an element which will be processed regularly, then Ext.get will be more appropriate to take advantage of the caching provided by the Ext.Element class.

Parameters

node	The id of the node or any object which represents an Ext.Element

Returns: Element

◆ Fly() [2/2]

static Element Ext.Net.X.Fly	(	object	node,
		string	named
	)

inlinestatic

Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - the dom node can be overwritten by other code. Shorthand of Ext.Element.fly Use this to make one-time references to DOM elements which are not going to be accessed again either by application code, or by Ext's classes. If accessing an element which will be processed regularly, then Ext.get will be more appropriate to take advantage of the caching provided by the Ext.Element class.

Parameters

node	The id of the node or any object which represents an Ext.Element
named	Allows for creation of named reusable flyweights to prevent conflicts

Returns: Element

◆ Form()

static Element Ext.Net.X.Form ( )

inlinestatic

Returns the current ASP.NET form as an Ext.Element.

Returns: Element

◆ Get() [1/2]

static Element Ext.Net.X.Get ( Control control )

inlinestatic

Retrieves Ext.Element objects. This method does not retrieve Components. This method retrieves Ext.Element objects which encapsulate DOM elements. Uses simple caching to consistently return the same object. Automatically fixes if an object was recreated with the same id via AJAX or DOM.

Parameters

control The Control to get as an Element object.

Returns: Element

◆ Get() [2/2]

static Element Ext.Net.X.Get ( object node )

inlinestatic

Retrieves Ext.Element objects. This method does not retrieve Components. This method retrieves Ext.Element objects which encapsulate DOM elements. Uses simple caching to consistently return the same object. Automatically fixes if an object was recreated with the same id via AJAX or DOM.

Parameters

node	The id of the node or any object which represents an Ext.Element

Returns: Element

◆ GetCmp()

static BaseControl Ext.Net.X.GetCmp ( string id )

inlinestatic

Returns a AbstractComponent by id.

Parameters

id	The AbstractComponent id

Returns: The AbstractComponent, or throws ArgumentNullException if not found

◆ GetCmp< T >() [1/4]

static T Ext.Net.X.GetCmp< T > ( string id )

inlinestatic

Returns the AbstractComponent by id and sets the .Value related fields by calling if available from the Request.

Parameters

id	The AbstractComponent id

Template Parameters

T	The Type of AbstractComponent to return.

Returns: The AbstractComponent, or throws ArgumentNullException if not found

Type Constraints

T	:	BaseControl
T	:	new()

◆ GetCmp< T >() [2/4]

static T Ext.Net.X.GetCmp< T >	(	string	id,
		BaseControl.Config	config
	)

inlinestatic

Returns the AbstractComponent by id and sets the .Value related fields by calling if available from the Request.

Parameters

id	The AbstractComponent id
config	Config for proxy widget

Template Parameters

T	The Type of AbstractComponent to return.

Returns: The AbstractComponent, or throws ArgumentNullException if not found

Type Constraints

T	:	BaseControl
T	:	new()

◆ GetCmp< T >() [3/4]

static T Ext.Net.X.GetCmp< T >	(	string	id,
		string	ns
	)

inlinestatic

Returns the AbstractComponent by id and sets the .Value related fields by calling if available from the Request.

Parameters

id	The AbstractComponent id
ns	Namespace

Template Parameters

T	The Type of AbstractComponent to return.

Returns: The AbstractComponent, or throws ArgumentNullException if not found

Type Constraints

T	:	BaseControl
T	:	new()

◆ GetCmp< T >() [4/4]

static T Ext.Net.X.GetCmp< T > ( T component )

inlinestatic

Returns the AbstractComponent and sets the .Value related fields by calling if available from the Request.

Template Parameters

T	The Type of AbstractComponent to return

Parameters

component The AbstractComponent instance

Returns

Type Constraints

T	:	BaseControl
T	:	new()

◆ GetCtl()

static Control Ext.Net.X.GetCtl ( string id )

inlinestatic

Get the Control with the specified id.

Parameters

id	The ID of the Control to find.

Returns: Control

◆ GetCtl< T >()

static T Ext.Net.X.GetCtl< T > ( string id )

inlinestatic

Get the Control with the specified id.

Template Parameters

T	The Type control to return

Parameters

id	The ID of the Control to find.

Returns: Control

Type Constraints

T	:	Control
T	:	new()

◆ GetValue()

static string Ext.Net.X.GetValue ( string id )

inlinestatic

Given the ID of a form field, returns the raw submmitted form value as a string. Returns 'null' if value can not be found.

Parameters

id	The ID of the submitted form field to be found

Returns: The form value as a string, or null if not found.

◆ Head()

static Element Ext.Net.X.Head ( )

inlinestatic

Returns the current HTML head object as an Ext.Element.

Returns: Element

◆ On()

static void Ext.Net.X.On ( GlobalListeners events )

inlinestatic

Appends an event handler to this object.

Parameters

events

Returns

◆ Redirect() [1/3]

static void Ext.Net.X.Redirect ( string url )

inlinestatic

Redirects a client to a new Url.

Parameters

url	The location of the target.

◆ Redirect() [2/3]

static void Ext.Net.X.Redirect	(	string	url,
		string	msg
	)

inlinestatic

Redirects a client to a new Url.

Parameters

url	The location of the target.
msg	The message to display in the loading mask which is rendered during the Redirect.

◆ Redirect() [3/3]

static void Ext.Net.X.Redirect	(	string	url,
		string	msg,
		string	msgCls
	)

inlinestatic

Redirects a client to a new Url.

Parameters

url	The location of the target.
msg	The message to display in the load mask which is rendered during the Redirect.
msgCls	A custom css class to apply to the load mask element.

◆ Reload() [1/3]

static void Ext.Net.X.Reload ( )

inlinestatic

Reloads the page by window.location.reload() call

◆ Reload() [2/3]

static void Ext.Net.X.Reload ( string msg )

inlinestatic

Reloads the page by window.location.reload() call

Parameters

msg	The message to display in the loading mask which is rendered during reloading.

◆ Reload() [3/3]

static void Ext.Net.X.Reload	(	string	msg,
		string	msgCls
	)

inlinestatic

Reloads the page by window.location.reload() call

Parameters

msg	The message to display in the load mask which is rendered during reloading.
msgCls	The custom CSS class to apply to the load mask element.

◆ ResumeLayouts() [1/2]

static void Ext.Net.X.ResumeLayouts ( )

inlinestatic

Resumes layout activity in the whole framework.

◆ ResumeLayouts() [2/2]

static void Ext.Net.X.ResumeLayouts ( bool flush )

inlinestatic

Resumes layout activity in the whole framework.

Parameters

flush true to perform all the pending layouts.

◆ Select() [1/3]

static Element Ext.Net.X.Select ( string selector )

inlinestatic

Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in one statement

Parameters

selector The CSS selector or an array of elements

Returns: Elements

◆ Select() [2/3]

static Element Ext.Net.X.Select	(	string	selector,
		bool	unique
	)

inlinestatic

Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in one statement

Parameters

selector	The CSS selector or an array of elements
unique	true to create a unique Ext.Element for each element (defaults to a shared flyweight object)

Returns: Elements

◆ Select() [3/3]

static Element Ext.Net.X.Select	(	string	selector,
		bool	unique,
		string	root
	)

inlinestatic

Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in one statement

Parameters

selector	The CSS selector or an array of elements
unique	true to create a unique Ext.Element for each element (defaults to a shared flyweight object)
root	id of the root

Returns: Elements

◆ Set()

static void Ext.Net.X.Set	(	string	name,
		object	value
	)

inlinestatic

◆ SetValue< T >()

static T Ext.Net.X.SetValue< T >	(	T	component,
		string	value
	)

inlinestatic

Sets the value of the component if the component is a typeof IField.

Template Parameters

T	The Type of AbstractComponent to return.

Parameters

component	The component
value	The value to set

Returns: Returns the component

Type Constraints

T

:

BaseControl

◆ SingleSelect() [1/3]

static Element Ext.Net.X.SingleSelect ( string selector )

inlinestatic

Selects first element based on the passed CSS selector

Parameters

selector The CSS selector

Returns: Elements

◆ SingleSelect() [2/3]

static Element Ext.Net.X.SingleSelect	(	string	selector,
		bool	unique
	)

inlinestatic

Selects first element based on the passed CSS selector

Parameters

selector	The CSS selector
unique

Returns: Elements

◆ SingleSelect() [3/3]

static Element Ext.Net.X.SingleSelect	(	string	selector,
		bool	unique,
		string	root
	)

inlinestatic

Selects first element based on the passed CSS selector

Parameters

selector	The CSS selector
unique
root

Returns

◆ SuspendLayouts()

static void Ext.Net.X.SuspendLayouts ( )

inlinestatic

◆ Toast() [1/4]

static void Ext.Net.X.Toast ( object componentConfig )

inlinestatic

Given an anonymous object with config options pertaining to a Toast component, display it on screen.

Parameters

componentConfig The anonymous object data.

ExtNet.Toast(new { Html = "toast text", Title = "toast title", Align = JSON.EnumToString(ToastAlign.TopLeft) });

◆ Toast() [2/4]

static void Ext.Net.X.Toast ( string message )

inlinestatic

Display a toast with the specified message on default location of the screen.

Parameters

message Message to display on the Toast pop up.

X.Toast("toast text");

◆ Toast() [3/4]

static void Ext.Net.X.Toast	(	string	message,
		string	title,
		ToastAlign	align = `ToastAlign.Default`,
		string	iconCls = `null`
	)

inlinestatic

Display a toast with the specified arguments settings on default location of the screen.

Parameters

message	Message to display on the Toast pop up.
title	Title of the pop up frame.
align	Alignment of the toast on screen.
iconCls	Class describing an icon to display on the toast title bar.

X.Toast("toast text", "toast title", ToastAlign.Bottom, "arrow");

◆ Toast() [4/4]

static void Ext.Net.X.Toast ( Toast component )

inlinestatic

Given an Ext.Net.Toast component, display it on screen.

Parameters

component Ext.Net.Toast component.

ExtNet.Toast(new Ext.Net.Toast() { Html = "toast text", Title = "toast title", Align = ToastAlign.TopLeft });

◆ Un()

static void Ext.Net.X.Un ( GlobalListeners events )

inlinestatic

Removes an event handler.

Parameters

events

Returns

◆ Window()

static Element Ext.Net.X.Window ( )

inlinestatic

Returns the current window object as an Ext.dom.Element. Typically used for attaching event listeners to the window. Note: since the window object is not an HTMLElement many of the Ext.dom.Element methods are not applicable and may throw errors if called on the returned Element instance.

Returns: The current window object as an Ext.dom.Element

Property Documentation

◆ Builder

BuilderFactory Ext.Net.X.Builder

staticget

◆ ControlsScripting

bool? Ext.Net.X.ControlsScripting

staticgetset

Returns

◆ IsAjaxRequest

bool Ext.Net.X.IsAjaxRequest

staticget

Determines if the current HttpRequest is an Ext.NET Ajax Request.

◆ Js

Js?? Ext.Net.X.Js

staticget

◆ Mask

Mask?? Ext.Net.X.Mask

staticget

◆ MessageBox

MessageBox?? Ext.Net.X.MessageBox

staticget

◆ Msg

MessageBox Ext.Net.X.Msg

staticget

◆ QuickTips

QuickTips?? Ext.Net.X.QuickTips

staticget

◆ ResourceManager

ResourceManager Ext.Net.X.ResourceManager

staticget

Returns an instance of the current Ext.NET ResourceManager.

◆ WindowManager

WindowManager?? Ext.Net.X.WindowManager

staticget

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

X.cs
Factory/Builder/Base/BuilderFactory.cs

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddScript() [1/2]

◆ AddScript() [2/2]

◆ Apply()

◆ Apply< T >()

◆ Body()

◆ Call() [1/2]

◆ Call() [2/2]

◆ ComponentQuery< T >()

◆ Defer() [1/2]

◆ Defer() [2/2]

◆ Document()

◆ Fly() [1/2]

◆ Fly() [2/2]

◆ Form()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetCmp()

◆ GetCmp< T >() [1/4]

◆ GetCmp< T >() [2/4]

◆ GetCmp< T >() [3/4]

◆ GetCmp< T >() [4/4]

◆ GetCtl()

◆ GetCtl< T >()

◆ GetValue()

◆ Head()

◆ On()

◆ Redirect() [1/3]

◆ Redirect() [2/3]

◆ Redirect() [3/3]

◆ Reload() [1/3]

◆ Reload() [2/3]

◆ Reload() [3/3]

◆ ResumeLayouts() [1/2]

◆ ResumeLayouts() [2/2]

◆ Select() [1/3]

◆ Select() [2/3]

◆ Select() [3/3]

◆ Set()

◆ SetValue< T >()

◆ SingleSelect() [1/3]

◆ SingleSelect() [2/3]

◆ SingleSelect() [3/3]

◆ SuspendLayouts()

◆ Toast() [1/4]

◆ Toast() [2/4]

◆ Toast() [3/4]

◆ Toast() [4/4]

◆ Un()

◆ Window()

Property Documentation

◆ Builder

◆ ControlsScripting

◆ IsAjaxRequest

◆ Js

◆ Mask

◆ MessageBox

◆ Msg

◆ QuickTips

◆ ResourceManager

◆ WindowManager