DataGridViewCell.GetClipboardContent Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Source:: DataGridViewCell.cs

Source:: DataGridViewCell.cs

Source:: DataGridViewCell.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

protected:
 virtual System::Object ^ GetClipboardContent(int rowIndex, bool firstCell, bool lastCell, bool inFirstRow, bool inLastRow, System::String ^ format);

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

protected virtual object? GetClipboardContent (int rowIndex, bool firstCell, bool lastCell, bool inFirstRow, bool inLastRow, string format);

abstract member GetClipboardContent : int * bool * bool * bool * bool * string -> obj
override this.GetClipboardContent : int * bool * bool * bool * bool * string -> obj

Protected Overridable Function GetClipboardContent (rowIndex As Integer, firstCell As Boolean, lastCell As Boolean, inFirstRow As Boolean, inLastRow As Boolean, format As String) As Object

Parameters

rowIndex: Int32

The zero-based index of the row containing the cell.

firstCell: Boolean

true to indicate that the cell is in the first column of the region defined by the selected cells; otherwise, false.

lastCell: Boolean

true to indicate that the cell is the last column of the region defined by the selected cells; otherwise, false.

inFirstRow: Boolean

true to indicate that the cell is in the first row of the region defined by the selected cells; otherwise, false.

inLastRow: Boolean

true to indicate that the cell is in the last row of the region defined by the selected cells; otherwise, false.

format: String

The current format string of the cell.

Returns

Object

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

Exceptions

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.

Remarks

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.

Applies to

Jaa