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

More...

Inheritance diagram for Ext.Net.DragSource.Builder< TDragSource, TBuilder >:
Ext.Net.DDProxy.Builder< TDragSource, TBuilder >

Public Member Functions

 Builder (TDragSource component)
 
virtual TBuilder Group (string group)
 A named drag drop group to which this object belongs. If a group is specified, then this object will only interact with other drag drop objects in the same group (defaults to undefined). More...
 
virtual TBuilder DragData (object dragData)
 
virtual TBuilder AnimRepair (bool animRepair)
 If true, animates the proxy element back to the position of the handle element used to trigger the drag. Defaults to: true More...
 
virtual TBuilder DropAllowed (string dropAllowed)
 The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). More...
 
virtual TBuilder DropNotAllowed (string dropNotAllowed)
 The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). More...
 
virtual TBuilder RepairHighlightColor (string repairHighlightColor)
 The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults to light blue). The color must be a 6 digit hex value, without a preceding '#'. Defaults to: "c3daf9" More...
 
virtual TBuilder AfterDragDrop (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action after a valid drag drop has occurred by providing an implementation. More...
 
virtual TBuilder AfterDragEnter (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action when the dragged item enters the drop target by providing an implementation. More...
 
virtual TBuilder AfterDragOut (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action after the dragged item is dragged out of the target without dropping. More...
 
virtual TBuilder AfterDragOver (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action while the dragged item is over the drop target by providing an implementation. More...
 
virtual TBuilder AfterInvalidDrop (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action after an invalid drop has occurred by providing an implementation. More...
 
virtual TBuilder AfterValidDrop (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action after an invalid drop has occurred by providing an implementation. More...
 
virtual TBuilder BeforeDragDrop (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action before the dragged item is dropped onto the target and optionally cancel the onDragDrop. More...
 
virtual TBuilder BeforeDragEnter (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action before the dragged item enters the drop target and optionally cancel the onDragEnter. More...
 
virtual TBuilder BeforeDragOut (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action before the dragged item is dragged out of the target without dropping, and optionally cancel the onDragOut. More...
 
virtual TBuilder BeforeDragOver (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action while the dragged item is over the drop target and optionally cancel the onDragOver. More...
 
virtual TBuilder BeforeInvalidDrop (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action after an invalid drop has occurred. More...
 
virtual TBuilder OnBeforeDrag (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action before the initial drag event begins and optionally cancel it. More...
 
virtual TBuilder OnStartDrag (Action< JFunction > action)
 An empty function by default, but provided so that you can perform a custom action once the initial drag event has begun. The drag cannot be canceled from this function. More...
 
virtual TBuilder GetDragData (Action< JFunction > action)
 Returns the data object associated with this drag source. More...
 
 Builder ()
 
 Builder (DragSource component)
 
 Builder (DragSource.Config config)
 
- Public Member Functions inherited from Ext.Net.DDProxy.Builder< TDragSource, TBuilder >
 Builder (TDDProxy component)
 
 Builder ()
 
 Builder (DDProxy component)
 
 Builder (DDProxy.Config config)
 
virtual TBuilder CenterFrame (bool centerFrame)
 By default the frame is positioned exactly where the drag element is, so we use the cursor offset provided by Ext.dd.DD. Another option that works only if you do not have constraints on the obj is to have the drag frame centered around the cursor. Set centerFrame to true for this effect. Defaults to: false More...
 
virtual TBuilder ResizeFrame (bool resizeFrame)
 By default we resize the drag frame to be the same size as the element we want to drag (this is to get the frame effect). We can turn it off if we want a different behavior. More...
 
virtual TBuilder AfterDrag (Action< JFunction > action)
 Abstract method runs on drag end More...
 

Static Public Member Functions

static implicit operator Builder (DragSource component)
 
- Static Public Member Functions inherited from Ext.Net.DDProxy.Builder< TDragSource, TBuilder >
static implicit operator Builder (DDProxy component)
 

Detailed Description

Type Constraints
TDragSource :DragSource 
TBuilder :Builder 
TBuilder :TDragSource 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.DragSource.Builder< TDragSource, TBuilder >.Builder ( TDragSource  component)
inline

◆ Builder() [2/4]

Ext.Net.DragSource.Builder< TDragSource, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.DragSource.Builder< TDragSource, TBuilder >.Builder ( DragSource  component)
inline

◆ Builder() [4/4]

Ext.Net.DragSource.Builder< TDragSource, TBuilder >.Builder ( DragSource.Config  config)
inline

Member Function Documentation

◆ AfterDragDrop()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.AfterDragDrop ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action after a valid drag drop has occurred by providing an implementation.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ AfterDragEnter()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.AfterDragEnter ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action when the dragged item enters the drop target by providing an implementation.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ AfterDragOut()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.AfterDragOut ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action after the dragged item is dragged out of the target without dropping.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ AfterDragOver()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.AfterDragOver ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action while the dragged item is over the drop target by providing an implementation.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ AfterInvalidDrop()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.AfterInvalidDrop ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action after an invalid drop has occurred by providing an implementation.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ AfterValidDrop()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.AfterValidDrop ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action after an invalid drop has occurred by providing an implementation.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ AnimRepair()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.AnimRepair ( bool  animRepair)
inlinevirtual

If true, animates the proxy element back to the position of the handle element used to trigger the drag. Defaults to: true

◆ BeforeDragDrop()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.BeforeDragDrop ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action before the dragged item is dropped onto the target and optionally cancel the onDragDrop.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ BeforeDragEnter()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.BeforeDragEnter ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action before the dragged item enters the drop target and optionally cancel the onDragEnter.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ BeforeDragOut()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.BeforeDragOut ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action before the dragged item is dragged out of the target without dropping, and optionally cancel the onDragOut.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ BeforeDragOver()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.BeforeDragOver ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action while the dragged item is over the drop target and optionally cancel the onDragOver.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ BeforeInvalidDrop()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.BeforeInvalidDrop ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action after an invalid drop has occurred.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ DragData()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.DragData ( object  dragData)
inlinevirtual

◆ DropAllowed()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.DropAllowed ( string  dropAllowed)
inlinevirtual

The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").

◆ DropNotAllowed()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.DropNotAllowed ( string  dropNotAllowed)
inlinevirtual

The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").

◆ GetDragData()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.GetDragData ( Action< JFunction action)
inlinevirtual

Returns the data object associated with this drag source.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ Group()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.Group ( string  group)
inlinevirtual

A named drag drop group to which this object belongs. If a group is specified, then this object will only interact with other drag drop objects in the same group (defaults to undefined).

◆ OnBeforeDrag()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.OnBeforeDrag ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action before the initial drag event begins and optionally cancel it.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ OnStartDrag()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.OnStartDrag ( Action< JFunction action)
inlinevirtual

An empty function by default, but provided so that you can perform a custom action once the initial drag event has begun. The drag cannot be canceled from this function.

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ operator Builder()

static implicit Ext.Net.DragSource.Builder< TDragSource, TBuilder >.operator Builder ( DragSource  component)
inlinestatic

◆ RepairHighlightColor()

virtual TBuilder Ext.Net.DragSource.Builder< TDragSource, TBuilder >.RepairHighlightColor ( string  repairHighlightColor)
inlinevirtual

The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults to light blue). The color must be a 6 digit hex value, without a preceding '#'. Defaults to: "c3daf9"


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