SpreadsheetControl.ClipboardDataObtained Event
Occurs after data on the clipboard is obtained and recognized, but before data is pasted.
Namespace: DevExpress.XtraSpreadsheet
Assembly: DevExpress.XtraSpreadsheet.v26.1.dll
Declaration
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
The event fires when the source of the data pasted is external to the application. 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. Handle the SpreadsheetControl.CopiedRangePasting event to modify the data being pasted when the source of the data is within the current application/workbook.
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.