Version 1
IColumnReorderEventArgs GrapeCity DataViewsJS Interface

IColumnReorderEventArgs Interface

Defines arguments of the event that occurs when the user starts dragging the column and before dropping the column in the column header

Heirarchy

  • IColumnReorderEventArgs

Properties

Optional cancel

cancel: boolean

If it is set to true, the action is canceled

Optional insertBefore

insertBefore: boolean

If it is set to true, the column is inserted before the drop target; otherwise, it is inserted after the target

Optional newIndex

newIndex: number | string

The drop target column. If the value is a string, it indicates the current reorder target is a column group and the value is the group caption. If the value is a number, it indicates the reorder column is a single column and the index is in the IGrid.columns collection

oldIndex

oldIndex: number | string

The original index of the reordered column. If the value is string, it indicates the current reorder target is a column group and the value is the group caption. If the value is a number, it indicates the reorder column is a single column and the index is in the IGrid.columns collection

status

status: "beforeColumnReorder" | "endColumnReorder"

Indicates the editing status. The status can be 'beforeColumnReorder' and 'endColumnReorder'.