Clipboard.IsCurrent(IDataObject) Clipboard.IsCurrent(IDataObject) Clipboard.IsCurrent(IDataObject) Clipboard.IsCurrent(IDataObject) Method

Definition

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

public:
 static bool IsCurrent(System::Windows::IDataObject ^ data);
public static bool IsCurrent (System.Windows.IDataObject data);
static member IsCurrent : System.Windows.IDataObject -> bool
Public Shared Function IsCurrent (data As IDataObject) As Boolean

Parameters

data
IDataObject IDataObject IDataObject IDataObject

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

Returns

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

Exceptions

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

Examples

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);

' For this example, the data to be placed on the clipboard is a simple
' string.
Dim textData As String = "I want to put this string on the clipboard."
' The example will enable auto-conversion of data for this data object.
Dim autoConvert As Boolean = True

' Create a new data object, specifying the data format, data to encapsulate, and enabling
' auto-conversion services.
Dim data As New DataObject(DataFormats.UnicodeText, CType(textData, Object), 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 Then
    ' Place the persisted data on the clipboard.
    Clipboard.SetDataObject(data, True)
Else
    ' Place the non-persisted data on the clipboard.
    Clipboard.SetDataObject(data, False)
End If

' 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.
Dim isOriginalDataObject As Boolean = Clipboard.IsCurrent(data)

Remarks

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

Applies to