Clipboard.IsCurrent Method (IDataObject)

 

Compares a specified data object to the contents of the Clipboard.

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

public static bool IsCurrent(
	IDataObject data
)

Parameters

data
Type: System.Windows.IDataObject

A data object to compare to the contents of the system Clipboard.

Return Value

Type: System.Boolean

true if the specified data object matches what is on the system Clipboard; otherwise, false.

Exception Condition
ArgumentNullException

data is null.

ExternalException

An error occurred when accessing the Clipboard. The exception details will include an HResult that identifies the specific error; see ErrorWrapper.ErrorCode.

Use this method to determine if a data object that was previously placed on the Clipboard is still present and unmodified.

The following example demonstrates the use of this method.


// For this example, the data to be placed on the clipboard is a simple
// string.
string textData = "I want to put this string on the clipboard.";
// The example will enable auto-conversion of data for this data object.
bool autoConvert = true;

// Create a new data object, specifying the data format, data to encapsulate, and enabling
// auto-conversion services.
DataObject data = new DataObject(DataFormats.UnicodeText, (Object)textData, autoConvert);

// If the data to be copied is supposed to be persisted after the application ends, 
// then set the second parameter of SetDataObject to true.
if(persistentData)
{
    // Place the persisted data on the clipboard.
    Clipboard.SetDataObject(data, true);
}
else
{
    // Place the non-persisted data on the clipboard.
    Clipboard.SetDataObject(data, false);
}

// If you keep a copy of the source data object, you can use the IsCurrent method to see if
// the data object is still on the clipboard.
bool isOriginalDataObject = Clipboard.IsCurrent(data);

.NET Framework
Available since 3.0
Return to top
Show: