EventCopyPaste
Feature

Allow using Ctrl/Cmd+C, Ctrl/Cmd+X and Ctrl/Cmd+V to copy/cut and paste events.

This feature also adds entries to the EventMenu for copying & cutting (see example below for how to configure) and to the ScheduleMenu for pasting.

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

If you want to highlight the paste location when clicking in the schedule, consider enabling the ScheduleContext feature.

When used with Scheduler Pro, pasting will bypass any constraint set on the event to allow the copy to be assigned the targeted date.

This feature is enabled by default.

Customize menu items

See EventMenu and ScheduleMenu for more info on customizing the menu items supplied by the feature. This snippet illustrates the concept:

// Custom copy text + remove cut option from event menu:
const scheduler = new Scheduler({
    features : {
        eventMenu : {
            items : {
                copyEvent : {
                    text : 'Copy booking'
                },
                cutEvent  : false
            }
        }
    }
});

Keyboard shortcuts

The feature has the following default keyboard shortcuts:

Keys	Action	Action description
`Ctrl`+`C`	copy	Copies selected event(s) into the clipboard.
`Ctrl`+`X`	cut	Cuts out selected event(s) into the clipboard.
`Ctrl`+`V`	paste	Insert copied or cut event(s) 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 our guide.

Multi assigned events

In a Scheduler that uses single assignment, copying and then pasting creates a clone of the event and assigns it to the target resource. Cutting and pasting moves the original event to the target resource.

In a Scheduler using multi assignment, the behaviour is slightly more complex. Cutting and pasting reassigns the event to the target, keeping other assignments of the same event intact. The behaviour for copying and pasting is configurable using the copyPasteAction config. It accepts two values:

'clone' - The default, the event is cloned and the clone is assigned to the target resource. Very similar to the behaviour with single assignment (event count goes up by 1).
'assign' - The original event is assigned to the target resource (event count is unaffected).

This snippet shows how to reconfigure it:

const scheduler = new Scheduler({
    features : {
        eventCopyPaste : {
            copyPasteAction : 'assign'
        }
    }
});

Copying multiple assignments of the same event will always result in all but the first assignment being removed on paste, since paste targets a single resource and an event can only be assigned to a resource once.

Native/shared clipboard

If you have multiple Schedulers (or other Bryntum products) on the same page, they will share clipboard. This makes it possible to copy and paste between different Scheduler instances. It is also possible to use the native Clipboard API if it is available and if you set useNativeClipboard to true.

Regardless of native clipboard availability, copy-pasting "outside" of the current Scheduler instance will convert the copied events to a string. When pasting, the string will then be parsed back into events. In case of usage of the native Clipboard API, this means it is possible to copy and paste events between completely different applications.

To configure the fields that is converted and parsed from the copied string value, please see the eventToStringFields config.

Useful configs and functions

Member	Description
beforeCopy	Fires before copy, return `false` to prevent
copy	Fires when events are copied
beforePaste	Fires before paste, return `false` to prevent
paste	Fires when events are pasted

Configs

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

copyPasteAction : 'clone'/'assign'clone
How to handle a copy paste operation when the host uses multi assignment. Either:
- 'clone' - The default, clone the copied event, assigning the clone to the target resource.
- 'assign' - Add an assignment for the existing event to the target resource.
For single assignment mode, it always uses the 'clone' behaviour.
eventToStringFields : String[]
When copying events (or assignments), data will be sent to the clipboard as a tab (\t) and new-line (\n) separated string with field values for fields present in this config (in specified order). The default included fields are (in this order):
- name
- startDate
- endDate
- duration
- durationUnit
- allDay To override, provide your own array of fields:
```
new Scheduler({
    features : {
        eventCopyPaste : {
            eventToStringFields : [
               'name',
               'startDate',
               'endDate',
               'percentDone'
            ]
        }
    }
});
```
Please note that this config is both used for **converting** events to a string value and is also used to **parse** a string value to events.
nameField : Stringname

The field to use as the name field when updating the name of copied records
unifiedPaste : Booleantrue

By default, pasting of multiple events will spread out according to the pattern it was copied. Set to false to paste into the same resource and same date.

Properties

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

isEventCopyPaste : Booleantrue

READONLY

static

ADVANCED

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

isEventCopyPaste : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

resolveTargetResources( records, resourceRecord )
: ResourceModel[]

private

Resolves the full list of target resources that events will be pasted to
stringConverter( data )
: String

private

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

private

Called from Clipboardable after reading from clipboard, and it is determined that the clipboard data is "external"
copyEvents( records, isCutfalse )
: Promise

ASYNC

ON-OWNER

Copy events (when using single assignment mode) or assignments (when using multi assignment mode) to clipboard to paste later

Triggers: beforeCopy, copy
pasteEvents( date, resourceRecord )
: Promise

ASYNC

ON-OWNER

Paste events or assignments to specified date and resource

Triggers: beforePaste, paste

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 Scheduler 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 Scheduler before a paste action is performed, return false to prevent the action. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

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

ON-OWNER

Fires on the owning Scheduler after a copy action is performed. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

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

ON-OWNER

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

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

ON-OWNER

Fires on the owning Scheduler if a paste action is not allowed. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

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 Scheduler 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 Scheduler before a paste action is performed, return false to prevent the action. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

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

ON-OWNER

Called on the owning Scheduler after a copy action is performed. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

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

ON-OWNER

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

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

ON-OWNER

Called on the owning Scheduler if a paste action is not allowed. Depending on if the EventStore is using singleAssignment or the configuration of copyPasteAction, either the eventRecords or the assignmentRecords param will be populated with record copies.

Note that this handler is called on the owning widget:

EventCopyPaste
Feature

Customize menu items

Keyboard shortcuts

Multi assigned events

Native/shared clipboard

Useful configs and functions

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree4

Mixins3

Contents

EventCopyPaste Feature

Customize menu items

Keyboard shortcuts

Multi assigned events

Native/shared clipboard

Useful configs and functions

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Inheritance tree4

Mixins3

Contents

EventCopyPaste
Feature