ClipboardPasteEvent

Defines event arguments for clipboard paste operations in the Grid component. Provides information about the data being pasted, including the source content and target cells or rows, allowing validation or custom paste logic. Contains contextual information about where data is being pasted and what data is being applied.

Props

The following table outlines the props for the ClipboardPasteEvent:

NameTypeDefaultDescription
cancel
boolean
false

Cancel the paste operation. Setting this to true prevents data from being applied to the grid.

clipboardText
string
''

Contains the raw clipboard text being pasted, including tabs and newlines. Raw format before parsing and validation.

pasteMatrix
string[][]
[ ]

Contains the parsed clipboard data organized as a two-dimensional matrix. Each inner array represents a row of tab-separated values from the clipboard. Format: [['value1', 'value2'], ['value3', 'value4']]

startColumnIndex
number
-1

Specifies the zero-based column index where the paste operation starts for cell selections. Indicates the first column receiving pasted data. Applicable only when selectionType is Cell.

startRowIndex
number
-1

Specifies the zero-based row index where the paste operation starts. Indicates the first row receiving pasted data.