DataGridViewRowHeaderCell::GetClipboardContent Method (Int32, Boolean, Boolean, Boolean, Boolean, String^)
Retrieves the formatted value of the cell to copy to the Clipboard.
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 ) override
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^A Object that represents the value of the cell to copy to the Clipboard.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | rowIndex is less than zero or greater than or equal to the number of rows in the control. |
Depending on the value of the ClipboardCopyMode property of the DataGridView control, this method is called by the control's GetClipboardContent method to retrieve a clipboard-formatted value that represents the cell.
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, formatting information may be returned by this method in addition to the 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.
Available since 2.0