SpreadsheetClipboardOptions.PasteFormat Property
Returns or specifies the format to use when data is pasted from the clipboard onto the Spreadsheet control.
Namespace: DevExpress.XtraSpreadsheet
Assembly: DevExpress.Spreadsheet.v24.1.Core.dll
NuGet Package: DevExpress.Spreadsheet.Core
Declaration
[DefaultValue(ClipboardPasteFormat.Default)]
public ClipboardPasteFormat PasteFormat { get; set; }
Property Value
Type | Default | Description |
---|---|---|
ClipboardPasteFormat | Default | An enumeration member that specifies the clipboard format. |
Available values:
Name | Description |
---|---|
Default | The Spreadsheet detects the appropriate format to paste clipboard data. |
Biff5 | Microsoft Excel 5.0/95 binary file format (BIFF5). |
Biff8 | Microsoft Excel 97 - 2003 binary file format (BIFF8). |
Biff12 | Microsoft Excel 2007 - 2010 binary file format (BIFF12). |
Csv | Comma-delimited text. |
TabDelimited | Tab-delimited text. |
DrawingObject | A drawing object (shape or chart). |
Metafile | An image in Windows Metafile Format (WMF) or Windows Enhanced Metafile Format (EMF). |
Image | A raster image. |
ImagesFromFiles | A list of file paths to inserted images. |
Property Paths
You can access this nested property as listed below:
Object Type | Path to PasteFormat |
---|---|
DocumentOptions |
|
Remarks
When the PasteFormat property is set to Default, the Spreadsheet control inserts data from the clipboard in the most appropriate format. When the Spreadsheet selects the clipboard format to use, it checks each format from the ClipboardPasteFormat enumeration to determine if the clipboard contains data in this format. If a matching format is found, the Spreadsheet stops the check and uses this format to retrieve data. Below is the order in which the Spreadsheet goes through its list of supported formats:
- ClipboardPasteFormat.Biff8
- ClipboardPasteFormat.Biff12
- ClipboardPasteFormat.Biff5
- ClipboardPasteFormat.Csv
- ClipboardPasteFormat.TabDelimited
- ClipboardPasteFormat.DrawingObject
- ClipboardPasteFormat.Metafile
- ClipboardPasteFormat.Image
- ClipboardPasteFormat.ImagesFromFiles
Use the PasteFormat property to explicitly specify the clipboard format the Spreadsheet control should use to insert data. For example, if you want to paste strings longer than 255 characters from the clipboard, set the PasteFormat property to Biff12. Otherwise, the Spreadsheet control uses the Biff8 (XLS) format to retrieve data and the inserted strings get truncated to 255 characters.
spreadsheetControl1.Options.Clipboard.PasteFormat = DevExpress.XtraSpreadsheet.ClipboardPasteFormat.Biff12;
If the Spreadsheet control cannot find data in the specified format in the clipboard, it uses the most relevant format to paste data (according to its list of supported formats).