RowCopyPaste
Feature

Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions available via the cell context menu.

You can configure how a newly pasted record is named using generateNewName

This feature is enabled by default

const grid = new Grid({
    features : {
        rowCopyPaste : true
    }
});

This feature will work alongside with CellCopyPaste but there is differences on functionality.

Context menu actions, and keyboard shortcuts, will be processed by either feature depending on what is selected and where the context menu was triggered. Set rowOptionsOnCellContextMenu to true to show two sets of options when context menu is triggered on a selected cell.
They share clipboard, so even when the internal clipboard is used, it is not possible to have rows and cells copied or cut at the same time.

Keyboard shortcuts

The feature has the following default keyboard shortcuts:

Keys	Action	Weight ¹	Action description
`Ctrl`+`C`	copy	10	Calls copyRows which copies selected row(s) into the clipboard.
`Ctrl`+`X`	cut	10	Calls copyRows which cuts out selected row(s) and saves in clipboard.
`Ctrl`+`V`	paste	10	Calls pasteRows which inserts copied or cut row(s) from the clipboard.

¹ Customization of keyboard shortcuts that has a weight can affect other features that also uses that particular keyboard shortcut. Read more in our guide.

Please note that Ctrl is the equivalent to Command and Alt is the equivalent to Option for Mac users

For more information on how to customize keyboard shortcuts, please see our guide.

Configs

Configs are options you supply in a configuration object when creating an instance of this class

columnTypesToIgnore : String[]["rownumber","sequenceNumber"]

internal

Specifies which column types should be omitted from copying.
cutOnly : Booleanfalse

If true, this translates copy actions to cut actions and removes the context menu Copy option.
nameField : Stringname

The field to use as the name field when updating the name of copied records
rowOptionsOnCellContextMenu : Booleanfalse

Adds Cut (row), Copy (row) and Paste (row) options when opening a context menu on a selected cell when cellSelection and CellCopyPaste is active. Default behaviour will only provide row copy/paste actions on a selected row.

Properties

Properties are getters/setters or publicly accessible variables on this class

isRowCopyPaste : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of RowCopyPaste class, or subclass thereof.

isRowCopyPaste : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of RowCopyPaste class, or subclass thereof.

Functions

Functions are methods available for calling on the class

copyRows( isCutfalse )
: Promise

ASYNC

ON-OWNER

Copy or cut selected rows to clipboard to paste later

Triggers: beforeCopy, copy
pasteRows( record )
: Model[]

ASYNC

ON-OWNER

Paste rows below selected or passed record

Triggers: beforePaste
extractParents( records, idMap, isPastetrue, isCutfalse )
: Model[]

private

Iterates over passed pre-sorted list of records and reassembles hierarchy of records.
monitorCellCopyPaste( )

internal

Listens to CellCopyPaste beforePaste events If user is trying to paste a string representation of a record from RowCopyPaste It will return false and paste the record instead
stringConverter( records )
: Promise

private

ASYNC

Called from Clipboardable after writing a non-string value to the clipboard
stringParser( clipboardData )
: Object[]

private

Called from Clipboardable after reading from clipboard, and it is determined that the clipboard data is "external"

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

beforeCopy

ASYNC

PREVENTABLE

ON-OWNER

Fires on the owning Grid before a copy action is performed, return false to prevent the action

Note that this event is triggered on the owning widget:
beforePaste

ASYNC

PREVENTABLE

ON-OWNER

Fires on the owning Grid before a paste action is performed, return false to prevent the action

Note that this event is triggered on the owning widget:
copy

ON-OWNER

Fires on the owning Grid after a copy action is performed.

Note that this event is triggered on the owning widget:
paste

ON-OWNER

Fires on the owning Grid after a paste action is performed.

Note that this event is triggered on the owning widget:

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onBeforeCopy

ASYNC

PREVENTABLE

ON-OWNER

Called on the owning Grid before a copy action is performed, return false to prevent the action

Note that this handler is called on the owning widget:
onBeforePaste

ASYNC

PREVENTABLE

ON-OWNER

Called on the owning Grid before a paste action is performed, return false to prevent the action

Note that this handler is called on the owning widget:
onCopy

ON-OWNER

Called on the owning Grid after a copy action is performed.

Note that this handler is called on the owning widget:
onPaste

ON-OWNER

Called on the owning Grid after a paste action is performed.

Note that this handler is called on the owning widget:

RowCopyPaste
Feature

Keyboard shortcuts

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree4

Mixins3

Contents

RowCopyPaste Feature

Keyboard shortcuts

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree4

Mixins3

Contents

RowCopyPaste
Feature