This documentation is archived and is not being maintained.

Clipboard.GetData Method

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.

ExceptionCondition
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

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: