GridControl.CopyingToClipboard Event

Occurs when grid data is copied to the clipboard. It allows you to manually copy required data.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public event CopyingToClipboardEventHandler CopyingToClipboard

VB.NET

Public Event CopyingToClipboard As CopyingToClipboardEventHandler

Event Data

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

Property	Description
CopyHeader	Gets whether column headers are copied to the clipboard. Inherited from CopyingToClipboardEventArgsBase.
GridCells	Gets an array of cells whose values are about to be copied to the clipboard.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
RowHandles	Gets an array of handles that correspond to rows whose values are to be copied to the clipboard. Inherited from CopyingToClipboardEventArgsBase.
Source	Gets the View that raised the event. Inherited from CopyingToClipboardEventArgsBase.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The GridControl provides the GridControl.CopyingToClipboard event that allows you to process copy operations manually. This event is raised before row values are copied to the clipboard by an end user or in code.

The following code sample demonstrates how to process data that is copied to the clipboard:

XAML

<dxg:GridControl CopyingToClipboard="OnCopyingToClipboard" />

C#

void OnCopyingToClipboard(object sender, CopyingToClipboardEventArgs e) {
    Clipboard.Clear();
    // You should manually implement the GetRowData() method 
    // that returns data to be copied to the clipboard.
    Clipboard.SetData(DataFormats.Text, GetRowData());
    e.Handled = true;
}

VB.NET

Private Sub OnCopyingToClipboard(ByVal sender As Object, ByVal e As CopyingToClipboardEventArgs)
    Clipboard.Clear()
    ' You should manually implement the GetRowData() method 
    ' that returns data to be copied to the clipboard.
    Clipboard.SetData(DataFormats.Text, GetRowData())
    e.Handled = True
End Sub 

Note

• The GridControl.CopyingToClipboard event is raised only if the GridControl does not have an active cell editor. Use the DataViewBase.ActiveEditor property to detect whether the GridControl contains an active cell editor.
• The GridControl.CopyingToClipboard event is not raised if the DataControlBase.ClipboardCopyMode property is set to ClipboardCopyMode.None.

Tip

Views provide two events that allow you to manually process clipboard operations.

• The CopyingToClipboard event is fired before row/cell values are copied to the clipboard by an end user, or in code. To cancel default processing, set the event parameter’s Handled property to true. This event isn’t fired if the DataControlBase.ClipboardCopyMode property is set to ClipboardCopyMode.None.
• The DataControlBase.PastingFromClipboard event is fired after an end user has pressed Ctrl+V or Shift+Ins.