DataGridView::GetClipboardContent Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Retrieves the formatted values that represent the contents of the selected cells for copying to the Clipboard.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public:
virtual DataObject^ GetClipboardContent()

Return Value

Type: System.Windows.Forms::DataObject^

A DataObject that represents the contents of the selected cells.

This method retrieves data that represents the region defined by the selected cells. This region is the smallest rectangle that includes all of the selected cells. The value for each selected cell in this region is retrieved by calling the DataGridViewCell::GetClipboardContent method. Blank placeholder values are used for unselected cells in this region. This method combines these values into a DataObject containing several formats for copying to the clipboard. The supported clipboard formats include DataFormats::Text, DataFormats::UnicodeText, DataFormats::Html, and DataFormats::CommaSeparatedValue.

For more information, see the Clipboard class.

Notes to Inheritors:

Override this method to provide customized clipboard values. This is useful, for example, to support copying values from custom cell types.

The following code example demonstrates how to programmatically add selected DataGridView content to the Clipboard. This example is part of a larger example available in How to: Enable Users to Copy Multiple Cells to the Clipboard from the Windows Forms DataGridView Control.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: