This documentation is archived and is not being maintained.

DataGridViewCell.GetClipboardContent Method

Retrieves the formatted value of the cell to copy to the Clipboard.

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

protected virtual Object GetClipboardContent(
	int rowIndex,
	bool firstCell,
	bool lastCell,
	bool inFirstRow,
	bool inLastRow,
	string format
)

Parameters

rowIndex
Type: System.Int32
The zero-based index of the row containing the cell.
firstCell
Type: System.Boolean
true to indicate that the cell is in the first column of the region defined by the selected cells; otherwise, false.
lastCell
Type: System.Boolean
true to indicate that the cell is the last column of the region defined by the selected cells; otherwise, false.
inFirstRow
Type: System.Boolean
true to indicate that the cell is in the first row of the region defined by the selected cells; otherwise, false.
inLastRow
Type: System.Boolean
true to indicate that the cell is in the last row of the region defined by the selected cells; otherwise, false.
format
Type: System.String
The current format string of the cell.

Return Value

Type: System.Object
An Object that represents the value of the cell to copy to the Clipboard.

ExceptionCondition
ArgumentOutOfRangeException

rowIndex is less than 0 or greater than or equal to the number of rows in the control.

InvalidOperationException

The value of the cell's DataGridView property is null.

-or-

ColumnIndex is less than 0, indicating that the cell is a row header cell.

Exception

Formatting failed and either there is no handler for the DataError event of the DataGridView control or the handler set the ThrowException property to true. The exception object can typically be cast to type FormatException.

This method is called by the DataGridView.GetClipboardContent method to retrieve a Clipboard-formatted value that represents the cell value.

The cell value is first retrieved in its display format from the GetEditedFormattedValue method. This may raise the DataGridView.CellFormatting event to format the value and the DataGridView.DataError event if formatting is unsuccessful.

The position-related parameters of this method indicate where this cell is located in the table of data representing the region defined by the selected cells in the DataGridView control. Depending on the cell's position, additional formatting information may be returned by this method along with the display-formatted cell value. For example, the HTML format for a cell in the first column of a row will include the tag that indicates the beginning of a row.

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. For example, you could override this method to support copying values from custom cell types.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: