RichTextBox.CanPaste Method

Determines whether you can paste information from the Clipboard in the specified data format.

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

public bool CanPaste(
	DataFormats.Format clipFormat
)

Return Value

Type: System.Boolean
true if you can paste data from the Clipboard in the specified data format; otherwise, false.

You can use this method to determine whether the current contents of the Clipboard are in a specified Clipboard data format before enabling the user to paste the information into the RichTextBox control. For example, you could create an event handler for a Popup event of a paste command MenuItem and use this method to determine whether the paste MenuItem should be enabled based on the type of data in the Clipboard.

The following code example demonstrates how to use the Paste method to paste a bitmap into the RichTextBox control. After opening a bitmap from file, the example uses the SetDataObject method to copy the bitmap to the Windows clipboard. Finally, the example retrieves the format for the Bitmap object, uses the CanPaste method to verify that the format can be pasted into the RichTextBox control, and then uses the Paste method to paste the data.

private bool pasteMyBitmap(string fileName)
{

	// Open an bitmap from file and copy it to the clipboard.
	Bitmap myBitmap = new Bitmap(fileName);
			
	// Copy the bitmap to the clipboard.
	Clipboard.SetDataObject(myBitmap);

	// Get the format for the object type.
	DataFormats.Format myFormat = DataFormats.GetFormat(DataFormats.Bitmap);

	// After verifying that the data can be pasted, paste it. 
	if(richTextBox1.CanPaste(myFormat))
	{
		richTextBox1.Paste(myFormat);
		return true;
	}
	else
	{
		MessageBox.Show("The data format that you attempted to paste is not supported by this control.");
		return false;
	}
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft