Clipboard.GetData Method (String)

 

Retrieves data in a specified format from the Clipboard.

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

public static object GetData(
	string format
)

Parameters

format
Type: System.String

A string that specifies the format of the data to retrieve. For a set of predefined data formats, see the DataFormats class.

Return Value

Type: System.Object

An object that contains the data in the specified format, or null if the data is unavailable in the specified format.

Exception Condition
ArgumentNullException

format is null.

The following example demonstrates the use of this method.


// After this line executes, IsHTMLDataOnClipboard will be true if
// HTML data is available natively on the clipboard; if not, it 
// will be false.
bool IsHTMLDataOnClipboard = Clipboard.ContainsData(DataFormats.Html);

// If there is HTML data on the clipboard, retrieve it.
string htmlData;
if(IsHTMLDataOnClipboard)
{

    htmlData = Clipboard.GetText(TextDataFormat.Html);

}

.NET Framework
Available since 3.0
Return to top
Show: