CellCopyPaste
Feature

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

Requires selectionMode.cell to be activated. Also, if the CellEdit feature is disabled, the copyOnly config will default to `true` which prevents cut-and-paste actions completely. Set copyOnly to `false` to prevent this behaviour.

This feature will work alongside with RowCopyPaste 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.

If the Clipboard API is available, that will be used. This enables copying and pasting between different Bryntum products or completely different applications. Please note that only string values are supported.

This feature is disabled by default

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

Keyboard shortcuts

The feature has the following default keyboard shortcuts:

Keys	Action	Action description
`Ctrl`+`C`	copy	Calls copy which copies selected cell values into the clipboard.
`Ctrl`+`X`	cut	Calls cut which cuts out selected cell values and saves in clipboard.
`Ctrl`+`V`	paste	Calls paste which inserts string values from the clipboard.

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 this guide.

Configs

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

useNativeClipboard : Booleantrue

Set this to false to not use native Clipboard API even if it is available

Properties

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

isCellCopyPaste : Booleantrue

READONLY

static

ADVANCED

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

isCellCopyPaste : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

copy( )
: Promise

ASYNC

Copies selected cells to clipboard (native if accessible) to paste later
cut( )
: Promise

ASYNC

Cuts selected cells to clipboard (native if accessible) to paste later
paste( )
: Promise

ASYNC

Pastes string data into a cell or a range of cells. Either from native clipboard if that is accessible or from a fallback clipboard that is only available to the owner Grid.

The string data will be split on \n and \t and put in different rows and columns accordingly.

Note that there must be a selected cell to paste the data into.

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:

CellCopyPaste
Feature

Keyboard shortcuts

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree4

Mixins3

Contents

CellCopyPaste Feature

Keyboard shortcuts

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree4

Mixins3

Contents

CellCopyPaste
Feature