Handles mapping key events to handling functions for an element or a Component. One KeyMap can be used for multiple actions. More...

Inheritance diagram for Ext.Net.KeyMap:

Classes
class	Builder

class	Config

Public Member Functions
	KeyMap ()

virtual void	Enable ()
	Enables this KeyMap More...

virtual void	Disable ()
	Disable this KeyMap More...

virtual void	SetDisabled (bool disabled)
	Convenience function for setting disabled/enabled by boolean. More...

virtual void	AddKeyBinding (KeyBinding keyBinding)

virtual void	Destroy (bool removeTarget)
	Destroys the KeyMap instance and removes all handlers. More...

override void	Destroy ()
	Destroys the KeyMap instance and removes all handlers. More...

string	ToScript (Control owner)

KeyMap.Builder	ToBuilder ()

override IControlBuilder	ToNativeBuilder ()

	KeyMap (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 > ()

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)

T	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< ClientStyleItem >	GetStyles ()

List< ClientStyleItem >	GetThemes ()

List< ClientScriptItem >	GetScripts ()

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 implicit	operator KeyMap (KeyMap.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)

Properties
override string	InstanceOf `[get]`

virtual KeyBindingCollection	Binding `[get]`
	Either a single object describing a handling function for s specified key (or set of keys), or an array of such objects. More...

virtual string	BindingProxy `[get]`

virtual string	EventName `[get, set]`
	The event to listen for to pick up key events. Defaults to: "keydown" More...

virtual bool	ComponentEvent `[get, set]`
	True to listen component event instead underlying element More...

virtual string	ComponentElement `[get, set]`
	Element name of target component (can be used if KeyMap belongs to a component) More...

virtual bool	IgnoreInputFields `[get, set]`
	Configure this as true if there are any input fields within the target, and this KeyNav should not process events from input fields, (<input>, <textarea> and elements withcontentEditable="true"`). Defaults to: false More...

virtual ? int?	Priority `[get, set]`
	The priority to set on this KeyMap's listener. Listeners with a higher priority are fired before those with lower priority. More...

virtual JFunction	ProcessEvent `[get]`
	An optional event processor function which accepts the argument list provided by the configured event of the target, and returns a keyEvent for processing by the KeyMap. More...

virtual string	ProcessEventScope `[get, set]`
	The scope (this context) in which the processEvent method is executed. More...

virtual string	Target `[get, set]`
	The object on which to listen for the event specified by the eventName config option. More...

virtual string	TargetProxy `[get]`

override ConfigOptionsCollection	ConfigOptions `[get]`

Properties inherited from Ext.Net.LazyObservable
override string	ConfigIDProxy `[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 LazyMode?	LazyMode `[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< ResourceItem >	Resources `[get]`

virtual List< ClientResourceItem >	ResourceItems `[get]`

virtual List< ResourceItem >	GlobalResources `[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< Observable >	LazyItems `[get]`

Additional Inherited Members
Protected Member Functions inherited from Ext.Net.Observable
override void	OnInit (EventArgs e)

virtual void	RegisterCustomAttribute (string key, string value)

virtual void	OnBeforeClientInit (Observable sender)

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)

Events inherited from Ext.Net.Observable
OnBeforeClientInitializedHandler	BeforeClientInit

OnAfterClientInitializedHandler	AfterClientInit

Detailed Description

Handles mapping key events to handling functions for an element or a Component. One KeyMap can be used for multiple actions.

A KeyMap must be configured with a target as an event source which may be an Element or a Component.

If the target is an element, then the keydown event will trigger the invocation of bindings.

It is possible to configure the KeyMap with a custom eventName to listen for. This may be useful when the target is a Component.

The KeyMap's event handling requires that the first parameter passed is a key event. So if the Component's event signature is different, specify a processEvent configuration which accepts the event's parameters and returns a key event.

Functions specified in bindings are called with this signature : (String key, Ext.EventObject e) (if the match is a multi-key combination the callback will still be called only once). A KeyMap can also handle a string representation of keys. By default KeyMap starts enabled.

Constructor & Destructor Documentation

◆ KeyMap() [1/2]

Ext.Net.KeyMap.KeyMap ( )

inline

◆ KeyMap() [2/2]

Ext.Net.KeyMap.KeyMap ( Config config )

inline

Member Function Documentation

◆ AddKeyBinding()

virtual void Ext.Net.KeyMap.AddKeyBinding ( KeyBinding keyBinding )

inlinevirtual

Parameters

keyBinding

◆ Destroy() [1/2]

override void Ext.Net.KeyMap.Destroy ( )

inlinevirtual

Destroys the KeyMap instance and removes all handlers.

Reimplemented from Ext.Net.BaseControl.

◆ Destroy() [2/2]

virtual void Ext.Net.KeyMap.Destroy ( bool removeTarget )

inlinevirtual

Destroys the KeyMap instance and removes all handlers.

Parameters

removeTarget True to also remove the target

◆ Disable()

virtual void Ext.Net.KeyMap.Disable ( )

inlinevirtual

Disable this KeyMap

◆ Enable()

virtual void Ext.Net.KeyMap.Enable ( )

inlinevirtual

Enables this KeyMap

◆ operator KeyMap()

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

inlinestatic

◆ SetDisabled()

virtual void Ext.Net.KeyMap.SetDisabled ( bool disabled )

inlinevirtual

Convenience function for setting disabled/enabled by boolean.

Parameters

disabled

◆ ToBuilder()

KeyMap.Builder Ext.Net.KeyMap.ToBuilder ( )

inline

◆ ToNativeBuilder()

override IControlBuilder Ext.Net.KeyMap.ToNativeBuilder ( )

inlinevirtual

Reimplemented from Ext.Net.BaseControl.

◆ ToScript()

string Ext.Net.KeyMap.ToScript ( Control owner )

inline

Implements Ext.Net.ICustomConfigSerialization.

Property Documentation

◆ Binding

virtual KeyBindingCollection Ext.Net.KeyMap.Binding

get

Either a single object describing a handling function for s specified key (or set of keys), or an array of such objects.

◆ BindingProxy

virtual string Ext.Net.KeyMap.BindingProxy

getprotected

◆ ComponentElement

virtual string Ext.Net.KeyMap.ComponentElement

getset

Element name of target component (can be used if KeyMap belongs to a component)

◆ ComponentEvent

virtual bool Ext.Net.KeyMap.ComponentEvent

getset

True to listen component event instead underlying element

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.KeyMap.ConfigOptions

get

◆ EventName

virtual string Ext.Net.KeyMap.EventName

getset

The event to listen for to pick up key events. Defaults to: "keydown"

◆ IgnoreInputFields

virtual bool Ext.Net.KeyMap.IgnoreInputFields

getset

Configure this as true if there are any input fields within the target, and this KeyNav should not process events from input fields, (<input>, <textarea> and elements withcontentEditable="true"`). Defaults to: false

◆ InstanceOf

override string Ext.Net.KeyMap.InstanceOf

get

◆ Priority

virtual ? int? Ext.Net.KeyMap.Priority

getset

The priority to set on this KeyMap's listener. Listeners with a higher priority are fired before those with lower priority.

◆ ProcessEvent

virtual JFunction Ext.Net.KeyMap.ProcessEvent

get

An optional event processor function which accepts the argument list provided by the configured event of the target, and returns a keyEvent for processing by the KeyMap.

This may be useful when the target is a Component with s complex event signature, where the event is not the first parameter. Extra information from the event arguments may be injected into the event for use by the handler functions before returning it.

◆ ProcessEventScope

virtual string Ext.Net.KeyMap.ProcessEventScope

getset

The scope (this context) in which the processEvent method is executed.

◆ Target

virtual string Ext.Net.KeyMap.Target

getset

The object on which to listen for the event specified by the eventName config option.

◆ TargetProxy

virtual string Ext.Net.KeyMap.TargetProxy

getprotected

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

KeyMap.cs
KeyMapConfigOptions.cs
KeyMapBuilder.cs
KeyMapConfig.cs

Classes

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KeyMap() [1/2]

◆ KeyMap() [2/2]

Member Function Documentation

◆ AddKeyBinding()

◆ Destroy() [1/2]

◆ Destroy() [2/2]

◆ Disable()

◆ Enable()

◆ operator KeyMap()

◆ SetDisabled()

◆ ToBuilder()

◆ ToNativeBuilder()

◆ ToScript()

Property Documentation

◆ Binding

◆ BindingProxy

◆ ComponentElement

◆ ComponentEvent

◆ ConfigOptions

◆ EventName

◆ IgnoreInputFields

◆ InstanceOf

◆ Priority

◆ ProcessEvent

◆ ProcessEventScope

◆ Target

◆ TargetProxy