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

More...

Inheritance diagram for Ext.Net.Editor.Builder< TEditor, TBuilder >:
Ext.Net.AbstractContainer.Builder< TEditor, TBuilder >

Public Member Functions

 Builder (TEditor component)
 
virtual TBuilder ActivateEvent (string activateEvent)
 Event name for activate the editor More...
 
virtual TBuilder Alignment (string alignment)
 The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?"). More...
 
virtual TBuilder AlignmentConfig (EditorAlignmentConfig alignmentConfig)
 The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?"). More...
 
virtual TBuilder AutoSize (bool autoSize)
 True for the editor to automatically adopt the size of the underlying field. Otherwise, an object can be passed to indicate where to get each dimension. The available properties are 'boundEl' and 'field'. If a dimension is not specified, it will use the underlying height/width specified on the editor object. More...
 
virtual TBuilder AutoSizeConfig (EditorAutoSize autoSizeConfig)
 True for the editor to automatically adopt the size of the underlying field. Otherwise, an object can be passed to indicate where to get each dimension. The available properties are 'boundEl' and 'field'. If a dimension is not specified, it will use the underlying height/width specified on the editor object. More...
 
virtual TBuilder AllowBlur (bool allowBlur)
 True to complete the editing process if in edit mode when the field is blurred. Defaults to true. More...
 
virtual TBuilder CancelOnBlur (bool cancelOnBlur)
 True to cancel the edit when the blur event is fired (defaults to false) More...
 
virtual TBuilder CancelOnEsc (bool cancelOnEsc)
 True to cancel the edit when the escape key is pressed. Defaults to: true More...
 
virtual TBuilder CompleteOnEnter (bool completeOnEnter)
 True to complete the edit when the enter key is pressed (defaults to false) More...
 
virtual TBuilder HideEl (bool hideEl)
 False to keep the bound element visible while the editor is displayed. Defaults to: true More...
 
virtual TBuilder Field (Action< ItemsCollection< Field >> action)
 The Field object (or descendant) More...
 
virtual TBuilder FocusOnToFront (bool focusOnToFront)
 Do not participate in the ZIndexManager's focus switching operations. When an editor is hidden, the ZIndexManager will not automatically activate the last visible floater on the stack. Defaults to: false More...
 
virtual TBuilder IgnoreNoChange (bool ignoreNoChange)
 True to skip the edit completion process (no save, no events fired) if the user completes an edit and the value has not changed. Applies only to string values - edits for other data types will never be ignored. Defaults to: false More...
 
virtual TBuilder Offsets (int[] offsets)
 The offsets to use when aligning. Defaults to [0, 0]. More...
 
virtual TBuilder ParentElement (string parentElement)
 An element to render to. Defaults to the document.body. More...
 
virtual TBuilder RevertInvalid (bool revertInvalid)
 True to automatically revert the field value and cancel the edit when the user completes an edit and the field validation fails (defaults to true) More...
 
virtual TBuilder SwallowKeys (bool swallowKeys)
 Handle the keydown/keypress events so they don't propagate (defaults to true) More...
 
virtual TBuilder UpdateEl (bool updateEl)
 True to update the innerHTML of the bound element when the update completes (defaults to false) More...
 
virtual TBuilder Value (string value)
 The data value of the underlying field (defaults to "") More...
 
virtual TBuilder TargetControl (Action< Control > action)
 
virtual TBuilder Target (string target)
 The target id to associate with this tooltip. More...
 
virtual TBuilder UseHtml (bool useHtml)
 true to use innerHTML of bound element, otherwise innerText will be used More...
 
virtual TBuilder HtmlEncode (bool htmlEncode)
 True to encode value before start editing More...
 
virtual TBuilder HtmlDecode (bool htmlDecode)
 True to decode value after editing More...
 
virtual TBuilder Listeners (Action< InlineEditorListeners > action)
 Client-side JavaScript Event Handlers More...
 
virtual TBuilder DirectEvents (Action< InlineEditorDirectEvents > action)
 Server-side DirectEventHandlers More...
 
virtual TBuilder CancelEdit (bool remainVisible)
 
virtual TBuilder CancelEdit ()
 
virtual TBuilder CompleteEdit (bool remainVisible)
 
virtual TBuilder CompleteEdit ()
 
virtual TBuilder Realign ()
 
virtual TBuilder Realign (bool autoSize)
 
virtual TBuilder StartEdit (string el, string value)
 Starts the editing process and shows the editor. More...
 
virtual TBuilder StartEdit (string el)
 Starts the editing process and shows the editor. More...
 
 Builder ()
 
 Builder (Editor component)
 
 Builder (Editor.Config config)
 

Static Public Member Functions

static implicit operator Builder (Editor component)
 

Detailed Description

Type Constraints
TEditor :Editor 
TBuilder :Builder 
TBuilder :TEditor 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.Editor.Builder< TEditor, TBuilder >.Builder ( TEditor  component)
inline

◆ Builder() [2/4]

Ext.Net.Editor.Builder< TEditor, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.Editor.Builder< TEditor, TBuilder >.Builder ( Editor  component)
inline

◆ Builder() [4/4]

Ext.Net.Editor.Builder< TEditor, TBuilder >.Builder ( Editor.Config  config)
inline

Member Function Documentation

◆ ActivateEvent()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.ActivateEvent ( string  activateEvent)
inlinevirtual

Event name for activate the editor

◆ Alignment()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.Alignment ( string  alignment)
inlinevirtual

The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?").

◆ AlignmentConfig()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.AlignmentConfig ( EditorAlignmentConfig  alignmentConfig)
inlinevirtual

The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?").

◆ AllowBlur()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.AllowBlur ( bool  allowBlur)
inlinevirtual

True to complete the editing process if in edit mode when the field is blurred. Defaults to true.

◆ AutoSize()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.AutoSize ( bool  autoSize)
inlinevirtual

True for the editor to automatically adopt the size of the underlying field. Otherwise, an object can be passed to indicate where to get each dimension. The available properties are 'boundEl' and 'field'. If a dimension is not specified, it will use the underlying height/width specified on the editor object.

◆ AutoSizeConfig()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.AutoSizeConfig ( EditorAutoSize  autoSizeConfig)
inlinevirtual

True for the editor to automatically adopt the size of the underlying field. Otherwise, an object can be passed to indicate where to get each dimension. The available properties are 'boundEl' and 'field'. If a dimension is not specified, it will use the underlying height/width specified on the editor object.

◆ CancelEdit() [1/2]

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.CancelEdit ( )
inlinevirtual

◆ CancelEdit() [2/2]

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.CancelEdit ( bool  remainVisible)
inlinevirtual

◆ CancelOnBlur()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.CancelOnBlur ( bool  cancelOnBlur)
inlinevirtual

True to cancel the edit when the blur event is fired (defaults to false)

◆ CancelOnEsc()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.CancelOnEsc ( bool  cancelOnEsc)
inlinevirtual

True to cancel the edit when the escape key is pressed. Defaults to: true

◆ CompleteEdit() [1/2]

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.CompleteEdit ( )
inlinevirtual

◆ CompleteEdit() [2/2]

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.CompleteEdit ( bool  remainVisible)
inlinevirtual

◆ CompleteOnEnter()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.CompleteOnEnter ( bool  completeOnEnter)
inlinevirtual

True to complete the edit when the enter key is pressed (defaults to false)

◆ DirectEvents()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.DirectEvents ( Action< InlineEditorDirectEvents action)
inlinevirtual

Server-side DirectEventHandlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ Field()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.Field ( Action< ItemsCollection< Field >>  action)
inlinevirtual

The Field object (or descendant)

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ FocusOnToFront()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.FocusOnToFront ( bool  focusOnToFront)
inlinevirtual

Do not participate in the ZIndexManager's focus switching operations. When an editor is hidden, the ZIndexManager will not automatically activate the last visible floater on the stack. Defaults to: false

◆ HideEl()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.HideEl ( bool  hideEl)
inlinevirtual

False to keep the bound element visible while the editor is displayed. Defaults to: true

◆ HtmlDecode()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.HtmlDecode ( bool  htmlDecode)
inlinevirtual

True to decode value after editing

◆ HtmlEncode()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.HtmlEncode ( bool  htmlEncode)
inlinevirtual

True to encode value before start editing

◆ IgnoreNoChange()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.IgnoreNoChange ( bool  ignoreNoChange)
inlinevirtual

True to skip the edit completion process (no save, no events fired) if the user completes an edit and the value has not changed. Applies only to string values - edits for other data types will never be ignored. Defaults to: false

◆ Listeners()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.Listeners ( Action< InlineEditorListeners action)
inlinevirtual

Client-side JavaScript Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ Offsets()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.Offsets ( int[]  offsets)
inlinevirtual

The offsets to use when aligning. Defaults to [0, 0].

◆ operator Builder()

static implicit Ext.Net.Editor.Builder< TEditor, TBuilder >.operator Builder ( Editor  component)
inlinestatic

◆ ParentElement()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.ParentElement ( string  parentElement)
inlinevirtual

An element to render to. Defaults to the document.body.

◆ Realign() [1/2]

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.Realign ( )
inlinevirtual

◆ Realign() [2/2]

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.Realign ( bool  autoSize)
inlinevirtual

◆ RevertInvalid()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.RevertInvalid ( bool  revertInvalid)
inlinevirtual

True to automatically revert the field value and cancel the edit when the user completes an edit and the field validation fails (defaults to true)

◆ StartEdit() [1/2]

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.StartEdit ( string  el)
inlinevirtual

Starts the editing process and shows the editor.

◆ StartEdit() [2/2]

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.StartEdit ( string  el,
string  value 
)
inlinevirtual

Starts the editing process and shows the editor.

◆ SwallowKeys()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.SwallowKeys ( bool  swallowKeys)
inlinevirtual

Handle the keydown/keypress events so they don't propagate (defaults to true)

◆ Target()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.Target ( string  target)
inlinevirtual

The target id to associate with this tooltip.

◆ TargetControl()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.TargetControl ( Action< Control >  action)
inlinevirtual

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ UpdateEl()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.UpdateEl ( bool  updateEl)
inlinevirtual

True to update the innerHTML of the bound element when the update completes (defaults to false)

◆ UseHtml()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.UseHtml ( bool  useHtml)
inlinevirtual

true to use innerHTML of bound element, otherwise innerText will be used

◆ Value()

virtual TBuilder Ext.Net.Editor.Builder< TEditor, TBuilder >.Value ( string  value)
inlinevirtual

The data value of the underlying field (defaults to "")


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