ClipboardCutEvent

Defines event arguments for clipboard cut operations in the Grid component. Provides information about the data being cut, including selected cells or rows, and allows cancellation of the operation. When successful, cut clears the selected cells/rows. Contains contextual information about what data is being cut and enables validation or custom cut logic.

Props

The following table outlines the props for the ClipboardCutEvent:

NameTypeDefaultDescription
cancel
boolean
false

Cancel the cut operation. Setting this to true prevents the data from being written to clipboard and clears the selected cells.

clipboardText
string
''

Contains the formatted tab-separated or newline-separated text content being cut to clipboard. For rectangular selections, uses tab-separated columns within each row. For scattered selections, uses newline-separated values.

copyWithHeaders
boolean
false

Specifies whether column headers are included in the cut content.

selectedCells
[ ]

List of selected cells being cut. Applicable only when selectionType is Cell. Contains row and column information for each selected cell.

selectedRowIndexes
number[]
[ ]

List of selected row indexes being cut. Applicable only when selectionType is Row. Contains zero-based row indexes in ascending order.