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

More...

Inheritance diagram for Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >:
Ext.Net.LazyObservable.Builder< TKeyMap, TBuilder >

Public Member Functions

 Builder (TKeyMap component)
 
virtual TBuilder Binding (Action< KeyBindingCollection > action)
 Either a single object describing a handling function for s specified key (or set of keys), or an array of such objects. More...
 
virtual TBuilder EventName (string eventName)
 The event to listen for to pick up key events. Defaults to: "keydown" More...
 
virtual TBuilder ComponentEvent (bool componentEvent)
 True to listen component event instead underlying element More...
 
virtual TBuilder ComponentElement (string componentElement)
 Element name of target component (can be used if KeyMap belongs to a component) More...
 
virtual TBuilder IgnoreInputFields (bool ignoreInputFields)
 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 TBuilder Priority (int? priority)
 The priority to set on this KeyMap's listener. Listeners with a higher priority are fired before those with lower priority. More...
 
virtual TBuilder ProcessEvent (Action< JFunction > action)
 
virtual TBuilder ProcessEventScope (string processEventScope)
 The scope (this context) in which the processEvent method is executed. More...
 
virtual TBuilder Target (string target)
 The object on which to listen for the event specified by the eventName config option. More...
 
 Builder ()
 
 Builder (KeyMap component)
 
 Builder (KeyMap.Config config)
 
- Public Member Functions inherited from Ext.Net.LazyObservable.Builder< TKeyMap, TBuilder >
 Builder (TLazyObservable component)
 

Static Public Member Functions

static implicit operator Builder (KeyMap component)
 

Detailed Description

Type Constraints
TKeyMap :KeyMap 
TBuilder :Builder 
TBuilder :TKeyMap 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.Builder ( TKeyMap  component)
inline

◆ Builder() [2/4]

Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.Builder ( KeyMap  component)
inline

◆ Builder() [4/4]

Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.Builder ( KeyMap.Config  config)
inline

Member Function Documentation

◆ Binding()

virtual TBuilder Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.Binding ( Action< KeyBindingCollection action)
inlinevirtual

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

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ ComponentElement()

virtual TBuilder Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.ComponentElement ( string  componentElement)
inlinevirtual

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

◆ ComponentEvent()

virtual TBuilder Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.ComponentEvent ( bool  componentEvent)
inlinevirtual

True to listen component event instead underlying element

◆ EventName()

virtual TBuilder Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.EventName ( string  eventName)
inlinevirtual

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

◆ IgnoreInputFields()

virtual TBuilder Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.IgnoreInputFields ( bool  ignoreInputFields)
inlinevirtual

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

◆ operator Builder()

static implicit Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.operator Builder ( KeyMap  component)
inlinestatic

◆ Priority()

virtual TBuilder Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.Priority ( int?  priority)
inlinevirtual

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

◆ ProcessEvent()

virtual TBuilder Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.ProcessEvent ( Action< JFunction action)
inlinevirtual

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ ProcessEventScope()

virtual TBuilder Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.ProcessEventScope ( string  processEventScope)
inlinevirtual

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

◆ Target()

virtual TBuilder Ext.Net.KeyMap.Builder< TKeyMap, TBuilder >.Target ( string  target)
inlinevirtual

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


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