Row moving and dragging

TreeGrid documentation

Rows in TreeGrid can be dragged inside one grid or between any two grids. The dropped rows can be moved or copied.
Only variable rows can be moved or copied!
By default every row can be dragged and every row accepts every child as drop target.
To control which row can be dragged use row's CanDrag attribute and/or OnStartDrag event.
To control which row accepts which child use Def and AcceptDef attributes. The row accepts as child only rows with Def attribute listed in the row's AcceptDef array. The root rows are controlled by <Root AcceptDef/>.
All the Def and AcceptDef settings are described in Default rows documentation.
Dynamically you can control dropping by OnCanDrop and OnEndDrag events.
If rows can be moved by mouse - the grid can be a source grid for drag / drop rows.
If rows can be dropped to this grid - the grid can be a target grid for drag / drop rows.
Since 14.0 it is not permitted dragging rows between grids with different SyncId except if set Dropping = 2.
If existing rows can be copied / duplicated.
If set to 0, the Panel Copy button is hidden and the CopyMenu does not display items for copying.
If set to 0, all Copy... actions fail but CopyRow and CopyRows methods still work.
(Since 10.0) If set to 0, the rows cannot be copied by dragging.
Copying is automatically disabled when set Adding='0'.
It is not related to Copy&Paste, it is controlled by Pasting.
If defined, shows drop position by outer arrows instead of showing it in the MainCol.
Useful especially for plain grid without MainCol. Default value is Index if not defined MainCol, otherwise it is null.
For copying between two grids. If set to 1 in source grid, rows are copied instead of moved - the moved rows are not deleted in the source grid.
It does not affect moving rows inside the same grid.
If set, the moved row between grids does not change its id. It is not used for copied rows.
You must ensure the rows have unique ids in both grids, including newly added rows - use different IdChars or IdPrefix in the grids.
If set, the OnRowCopyId is not called for the moved rows.
If copies also deleted rows.
Since 10.0 it is used also for copied rows by dragging, in previous version the deleted rows were copied always, now only if set it to 1.
If set, dragging actions are permitted even if the grid is in edit mode.
If set to 1, the grid finishes editing on mouse down at any other cell than edited one.
If set to 2, (since 12.0) the editing is not finished during dragging.
It is still not possible to drag row by the cell being edited.
If shows dragged object under mouse cursor. The dragged row(s) or moved column(s).
It can be changed by a user in configuration menu
What is shown under mouse cursor when dragging rows.
0 - nothing
1 - the first dragged row proxy. If dragged more rows, the border of the proxy is thicker
2 - row name or count of dragged rows, in Grid.CSS is represented by class GxDragObject.
If set to 1, it is possible to drop rows above fixed sections.
If the row is dropped to head section, it is placed as the first root row, if the row is dropped to foot section, it is placed as the last root row.
Since 14.0 if set to 2, it is possible to drop to only NoData fixed row shown in empty grid.
If set 1, expands row when dragging row and mouse goes over the expand icon of not expanded row.
If set, scrolls grid down if the dragging mouse hovers foot section and scrolls up if mouse hovers head section.
Since 7.0 it specifies the scrolling speed, for how many pixels will be scrolled in one step, the original value 1 is changed to 50.
If set 1, does not show dragging icon during dragging.
Only for touch screens.
If set to 1, it permits dragging only focused object (row, image, Gantt bar, Gantt icon or Gantt line). It affects also link navigation.
If set to 2 permits dragging focused cell, not only focused row. Gantt is the same as for 1.
First tap on the object to focus it and next touch and move or resize it.
Similarly tap to empty space in Gantt chart and next touch and drag to create new bar.
It affects also showing Gantt menu - tap on the Gantt object and tap on it again to show the popup GanttMenu.
Only for touch screens.
Time in milliseconds; after that time the focus from actually focused cell or Gantt object is cleared.
0 means never.
If row can be moved by mouse dragging. Not applicable for fixed rows. Fixed rows cannot also be drop target.
If row can by caught by cell in this column and being dragged. Set it to 0 to let a user to select text in cell instead of dragging.
If the row can be duplicated and copied.
If set to 0, the Panel Copy button is inactive and all Copy... actions fail but CopyRow and CopyRows methods still work.
The row cannot be also copied by dragging.
Since 10.0 it is tested also for copied rows by dragging.
It is not related to copying values into clipboard.
If and how the row has been moved inside the grid. 0 - no, 1 - to another position in the same parent, 2 - to another parent.
When sorting is enabled, the value 1 is not used.
When the row is moved between grids, it is marked as Added in target grid and Deleted in source grid. No Moved flag is set in this case.
After uploading changes to server or calling AcceptChanges the moved row just looses its state and becomes normal row.
This attribute is set when used ChildPaging=3 and the row was created as deep copy of another row, the Copy is id of the source row.
This attribute is set only if the source row has some children and they were not loaded from server yet (the row was not expanded yet).
The server script must provide deep copy of the children of source (Copy) node to children of this (id) node.
Since 10.0 it is set also for copied rows by dragging.
When the row is moved or added, this is id of the new parent row or position of page (from 0).
When the row is moved or added, this is id of the row below or "" if the row is the last row in its parent.
When the row is moved or added, this is id of the row above or "" if the row is the first row in its parent.
If the default Panel button Move is visible. This button is hidden also if <Cfg Dragging="0"/>. This button is inactive when the row has CanDrag='0'.
Dragging this button moves the row. Use this button if dragging row by cells has different function like selecting cells.
Used only if the Buttons and the cell value are not set.
Called before the row is being dragged. Return true to suppress dragging the row.
row is the caught row, col is column where the row is caught, more is true when more selected rows will be dragged together.
copy (since 8.0) is true if the row will be copied instead of moved.
rows (since 10.0) are all the moved rows (when moved more selected rows). It does not contain children of moved rows.
Called after the dragged row is dropped. It is called for any drop, even not permitted.
grid, row - dragged source row, togrid, torow - drop target - row under mouse cursor
type - 0 - cannot drop, 1 - above torow, 2 - to the end of children of torow, 3 - below torow
X, Y - mouse cursor position on screen (related to browser window)
togrid is never null, it is the last grid that was under mouse cursor. torow is null when no row is under mouse cursor in time of drop.
copy (since 8.0) is true if the row will be copied instead of moved.
rows (since 10.0) are all the moved rows (when moved more selected rows). It does not contain children of moved rows.
Return new type to change dropping results.
Called after the dragged row is dropped and all changes are already done. Parameters are the same as in OnEndDrag.
Called during dragging row above other rows (drop targets) to find out if and how row can be dropped to this target.
It is called even if the dropping here is restricted (with type = 0). It is not called for grids with <Cfg Dropping='0'/>.
grid, row - dragged source row, togrid, torow - drop target - row under mouse cursor,
type - 0 - cannot drop, 1 - above torow, 2 - to the end of children of torow, 3 - below torow
copy is true if the source row will be copied, not moved.
rows (since 10.0) are all the moved rows (when moved more selected rows). It does not contain children of moved rows.
Return new type to change dropping permits.
This event controls dropping. To control which rows can be dragged (caught), set the row attribute CanDrag or set <Cfg Dragging> for whole grid or use OnStartDrag event.
Called after row is moved or copied to another grid. Called from function MoveRowsToGrid( ).
In time of call new row (torow) is positioned and displayed in target grid (togrid).
Old row (row) is still not deleted in source grid (grid).
If copy = true, old row will not be deleted.
return null to default behavior according to copy, or 0 to move, 1 to copy and -1 to remove source row.
Called after row has been moved inside one grid. Called from function MoveRow( ).
The row is still displayed in old position but have new settings.
oldparent is original parent of the row, oldnext is original next sibling.
Called before creating id for the new moved / copied row, the row has already copied the IdNames columns, the other columns will be copied later.
Since 8.1 it can set the row id and return true to not generate the new id.
Since 10.0 move is set when the row is moved from another grid.
Called when moving row between grids. Called before copying values from old default row to the new row.
Use if the default row of copied row differ between grids to copy only some attributes and return true.
move is set when the row is moved from another grid.
Moves row with all its children to the parent's children in front of next row. parent can be row, page or null. If show = true, displays changes.
If next is null, moves new row as last parent's child. If parent and next are null, moves row as the last root row.
If the row is first row in spanned range (has set RowSpan for some cell), it moves the whole range.
Moves row with all its children inside one grid. It converts its parameters and calls MoveRow.
row is the row to move, type - 1 - above torow, 2 - to the end of children of torow, 3 - below torow
If the row is first row in spanned range (has set RowSpan for some cell), it moves the whole range.
Moves or copies row to another (or the same) grid. Displays changes. Returns added row from source (calling) grid.
row is the row to move or copy, togrid is target grid. If target grid is the same as source grid it calls MoveRows.
type - 1 - above torow, 2 - to the end of children of torow, 3 - below torow
If copy is 0, row (and its children) is added to target grid (marked as Added) and deleted from source grid (marked as Deleted).
If copy is 1, row (and its children) is added to target grid, but it is not deleted from source grid.
If copy is 2, copies only row, without its children.
Copies all row and cell attributes except when replacing deleted row with the same id. Does not copy RowSpan.
If copy is 0 and in target grid already exists deleted row with the same id as source row, to the target grid is not added new row, but the existing target row is moved to new position and filled with cell values from source row and the source row is deleted!
If copy is 0 it preserves creating new and new rows when moving one row more times between two grids.
Since 7.0 replaces only deleted rows with the same id. Also copies all attributes not only values.
Useful for dragging external object into grid (or anywhere else)
Attaches copy of given HTML tag to mouse cursor to simulate its dragging. Call it only on mouse down.
Automatically removes the attached object on mouse up. You can call DragByMouse without parameters to remove the object manually.
The ghost object is placed below mouse cursor to not suppress standard mouse events.
tag is HTML tag to be dragged. It is not modified by this function. It is used to get its position, class and innerHTML.
event is standard HTML MouseEvent, the function used its clientX and clientY for placing the ghost object.
move can be direction to move the ghost object only, 1 - horizontally, 2 - vertically
html is html to filled into ghost object. If not set, the tag.innerHTML is used.
function func (param) is called when the ghost object is removed (usually on mouse up). param is any custom parameter.
Starts dragging actual row with all its children to new position. Dropped row will be moved.
Starts dragging selected rows with all their children to new position. Dropped rows will be moved.
Fails if actual row is not selected. It is possible to drag selected rows only by dragging one of them.
Starts dragging rows inside focused rect, with all their children to new position. Dropped rows will be moved.
Fails if actual row is not focused. It is possible to drag focused rows only by dragging one of them.
Starts dragging actual row without its children to new position. Dropped row will be copied.
Like DragRow, but copies row, without its children.
Since 7.0 it fails also when set Adding='0' or Copying='0'.
Starts dragging selected rows without their children to new position. Dropped rows will be copied.
Fails if actual row is not selected. It is possible to drag selected rows only by dragging one of them.
Like DragSelected, but copies rows, without their children.
Since 7.0 it fails also when set Adding='0' or Copying='0'.
Starts dragging focused rows without their children to new position. Dropped rows will be copied.
Fails if actual row is not focused. It is possible to drag focused rows only by dragging one of them.
Like DragFocused, but copies rows, without their children.
It fails also when set Adding='0' or Copying='0'.
Starts dragging actual row with all its children to new position. Dropped row will be copied.
Like DragRow, but copies row, with all its children.
Since 7.0 it fails also when set Adding='0' or Copying='0'.
Starts dragging selected rows with their children to new position. Dropped rows will be copied.
Fails if actual row is not selected. It is possible to drag selected rows only by dragging one of them.
Like DragSelected, but copies rows, with all their children.
Since 7.0 it fails also when set Adding='0' or Copying='0'.
Starts dragging focused rows with their children to new position. Dropped rows will be copied.
Fails if actual row is not focused. It is possible to drag focused rows only by dragging one of them.
Like DragFocused, but copies rows, with all their children.
It fails also when set Adding='0' or Copying='0'.
Custom dragging of the cell. It does not provide any action on drop, just calls custom events.
On mouse down, the cell content is attached to the mouse cursor.
On start calls OnStartDragCell, while moving there is called API event OnMoveDragCell, on mouse up there is called OnEndDragCell API event.
Called when started dragging by action DragCell.
grid, row, col - dragged source cell,
html - html to be attached to mouse as ghost object for dragging
return true to suppress dragging or return new html to attach it to mouse cursor.
Called during dragging by action DragCell.
grid, row, col - dragged source cell,
togrid, torow, tocol - drop target - cell under mouse cursor or null when dragging outside. togrid is never null, it is the last grid that was under mouse cursor
X, Y - mouse cursor position on screen (related to browser window)
Since 12.0 return true to set drag cursor, return false to set no drag cursor, return null to not change mouse cursor.
Called the dragged cell is dropped, started by action DragCell.
grid, row, col - dragged source cell,
togrid, torow, tocol - drop target - cell under mouse cursor or null when dragging outside. togrid is never null, it is the last grid that was under mouse cursor
X, Y - mouse cursor position on screen (related to browser window)
If the row can be moved to/from fixed section by actions and methods FixAbove / FixBelow.
Default is 1 for all data rows and 0 for Space, Header and Filter rows.
Fixes all rows above the focused or hovered row.
Moves all rows above the row to the end of Head section and moves the row and all below rows to the beginning of Body section.
Fixes all rows below the focused or hovered row.
Moves all rows below the row to the beginning of Foot section and moves the row and all above rows to the end of Body section.
Moves all rows above the row to the end of Head section and moves the row and all below rows to the beginning of Body section.
If set undo, the action is added to the undo buffer.
Returns true if some change was done and the grid was re-rendered. Moves all rows below the row to the beginning of Foot section and moves the row and all above rows to the end of Body section.
If set undo, the action is added to the undo buffer.
Returns true if some change was done and the grid was re-rendered.