Class DxGridRowDragging

Configures row dragging and reordering.

Inheritance

System.Object

DxGridRowDragging

Namespace: Emby.Web.GenericEdit.Elements.DxGrid

Assembly: Emby.Web.GenericEdit.dll

Syntax

public class DxGridRowDragging

Properties

allowDropInsideItem

Allows users to drop a row inside another row.

Declaration

public bool? allowDropInsideItem { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The allow drop inside item.

Remarks

This option allows users to drop rows only in the UI. You should also handle drag-and-drop in code. If users drag and drop rows inside a single component, use the onReorder handler. To allow users to drag and drop rows between components, use the onAdd handler.

allowReordering

Allows row reordering using drag and drop gestures.

Declaration

public bool? allowReordering { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The allow reordering.

Remarks

This option only enables dragging. You should also implement the reordering logic in the onReorder handler to enable row reordering inside a component. If you need to perform cross-component drag-and-drop, implement the dragging logic in the onAdd handler.This option only enables dragging. You should also implement the reordering logic in the onReorder handler to enable row reordering inside a component. If you need to perform cross-component drag-and-drop, implement the dragging logic in the onAdd handler.

animation

Gets or sets the animation in dropfeedbackmode push.

Declaration

public DxGridRowDragging.RowAnimation animation { get; set; }

Property Value

Type	Description
DxGridRowDragging.RowAnimation	The animation configuration.

Remarks

This is not officially documented.

autoScroll

Enables automatic scrolling while dragging a row beyond the viewport.

Declaration

public bool? autoScroll { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The automatic scroll.

Remarks

Default: true.

boundary

Specifies a DOM element that limits the dragging area.

Declaration

public string boundary { get; set; }

Property Value

Type	Description
System.String	The boundary.

container

Specifies a custom container in which the draggable row should be rendered.

Declaration

public string container { get; set; }

Property Value

Type	Description
System.String	The container.

cursorOffset

Specifies the cursor offset from the dragged row.

Declaration

public DxGridRowDragging.xyOffset cursorOffset { get; set; }

Property Value

Type	Description
DxGridRowDragging.xyOffset	The cursor offset.

data

A container for custom data.

Declaration

public object data { get; set; }

Property Value

Type	Description
System.Object	The data.

dragDirection

Specifies the directions in which a row can be dragged.

Declaration

public DxGridRowDragging.DragDirection? dragDirection { get; set; }

Property Value

Type	Description
System.Nullable<DxGridRowDragging.DragDirection>	The drag direction.

Remarks

Default Value: 'both'.

dropFeedbackMode

Specifies how to highlight the row's drop position.

Declaration

public DxGridRowDragging.DropFeedbackMode? dropFeedbackMode { get; set; }

Property Value

Type	Description
System.Nullable<DxGridRowDragging.DropFeedbackMode>	The drop feedback mode.

dropInsideItem

Declaration

public bool? dropInsideItem { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

filter

Specifies a CSS selector for draggable rows.

Declaration

public string filter { get; set; }

Property Value

Type	Description
System.String	The filter.

group

Allows you to group several widgets so that users can drag and drop rows between them.

Declaration

public string group { get; set; }

Property Value

Type	Description
System.String	The group.

Remarks

Set this option to identical values for the widgets you want to collect in a single group.

handle

Specifies a CSS selector (ID or class) for the element(s) that should act as the drag handle(s).

Declaration

public string handle { get; set; }

Property Value

Type	Description
System.String	The handle.

scrollSensitivity

Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true.

Declaration

public double? scrollSensitivity { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	The scroll sensitivity.

Remarks

Default Value: 60.

scrollSpeed

Specifies the scrolling speed when dragging a row beyond the viewport. Applies only if autoScroll is true.

Declaration

public double? scrollSpeed { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>	The scroll speed.

Remarks

Default Value: 30.

showDragIcons

Shows or hides row dragging icons.

Declaration

public bool? showDragIcons { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The show drag icons.

Extension Methods

Extensions.JsonClone<T>(T, IJsonSerializer)