Skip to main content

SpreadsheetControl.ClipboardDataObtained Event

Occurs after data on the clipboard is obtained and recognized, but before data is pasted.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.1.dll

NuGet Package: DevExpress.Win.Spreadsheet

Declaration

public event ClipboardDataObtainedEventHandler ClipboardDataObtained

Event Data

The ClipboardDataObtained event's data class is ClipboardDataObtainedEventArgs. The following properties provide information specific to this event:

Property Description
Cancel Gets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.
Flags Gets or sets the part of the copied data to be pasted into the target range.
Range Gets or sets a cell range in a worksheet from the temporary document model (returned by the ClipboardDataObtainedEventArgs.GetWorksheet method) containing data to be pasted.

The event data class exposes the following methods:

Method Description
GetWorksheet() Gets a worksheet from the temporary document model containing data to be pasted.

Remarks

Handle this event to modify the copied data before it is pasted into the target cells. Set the ClipboardDataObtainedEventArgs.Cancel property to true to cancel the paste operation.

This event is the second in a sequence of three events that fire when data is pasted from a cell’s in-place editor or external application. It occurs after the SpreadsheetControl.ClipboardDataPasting event and before the SpreadsheetControl.ClipboardDataPasted event.

See Also