Class GridRowDropEventArgs
Provides data for the event raised when a drop is requested, before the operation is committed.
Inheritance
Inherited Members
Namespace: Syncfusion.WinForms.DataGrid.Events
Assembly: Syncfusion.SfDataGrid.WinForms.dll
Syntax
public class GridRowDropEventArgs : EventArgs
Constructors
GridRowDropEventArgs(Object, ObservableCollection<Object>, DropPosition, Object, Boolean)
Initializes a new instance of the GridRowDropEventArgs class.
Declaration
public GridRowDropEventArgs(object data, ObservableCollection<object> draggingRecords, DropPosition dropPosition, object targetRecord, bool isFromOutsideSource)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | data | The drag payload or data object. |
| System.Collections.ObjectModel.ObservableCollection<System.Object> | draggingRecords | The records being dragged. |
| DropPosition | dropPosition | The suggested drop position. |
| System.Object | targetRecord | The record that is the target of the drop. |
| System.Boolean | isFromOutsideSource | True if the drag originated outside the grid; otherwise, false. |
Properties
Data
Gets the data object associated with the drop operation.
Declaration
public object Data { get; }
Property Value
| Type |
|---|
| System.Object |
DraggingRecords
Gets the collection of records being dragged.
Declaration
public IReadOnlyList<object> DraggingRecords { get; }
Property Value
| Type |
|---|
| System.Collections.Generic.IReadOnlyList<System.Object> |
DropPosition
Gets the suggested drop position relative to the target record.
Declaration
public DropPosition DropPosition { get; }
Property Value
| Type |
|---|
| DropPosition |
Handled
Gets or sets a value indicating whether the event is handled. Set this to true to implement custom drop logic or to cancel the default behavior.
Declaration
public bool Handled { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsFromOutsideSource
Gets a value indicating whether the drag originated outside the grid.
Declaration
public bool IsFromOutsideSource { get; }
Property Value
| Type |
|---|
| System.Boolean |
TargetRecord
Gets the record that is the target of the drop, if available.
Declaration
public object TargetRecord { get; }
Property Value
| Type |
|---|
| System.Object |