ClipboardObject Class

Represents a clipboard object for the purpose of data transfer. This object interoperates between DataObject, IDataObject, and IDataObject.

Namespace:  Microsoft.VisualStudio.Data.Framework
Assembly:  Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

public class ClipboardObject : DataObject, 
	IDataObject, IDataObject

The ClipboardObject type exposes the following members.

  NameDescription
Public methodClipboardObject()Initializes a new instance of the ClipboardObject class based on the standard DataObject class.
Public methodClipboardObject(Object)Initializes a new instance of the ClipboardObject class containing the specified data, or wraps an existing instance of the class.
Public methodClipboardObject(String, Object)Initializes a new instance of the ClipboardObject class containing the specified data in the specified format.
Top

  NameDescription
Public methodContainsAudioIndicates whether the data object contains data in the WaveAudio format. (Inherited from DataObject.)
Public methodContainsFileDropListIndicates whether the data object contains data that is in the FileDrop format or can be converted to that format. (Inherited from DataObject.)
Public methodContainsImageIndicates whether the data object contains data that is in the Bitmap format or can be converted to that format. (Inherited from DataObject.)
Public methodContainsText()Indicates whether the data object contains data in the UnicodeText format. (Inherited from DataObject.)
Public methodContainsText(TextDataFormat)Indicates whether the data object contains text data in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAudioStreamRetrieves an audio stream from the data object. (Inherited from DataObject.)
Public methodGetData(String)Retrieves the data stored in the clipboard object in the specified format. (Overrides DataObject.GetData(String).)
Public methodGetData(Type)Retrieves the data stored in the clipboard object in the specified format. (Overrides DataObject.GetData(Type).)
Public methodGetData(String, Boolean)Retrieves the data stored in the clipboard object in the specified format, using an automated conversion parameter to determine whether to convert the data to the format. (Overrides DataObject.GetData(String, Boolean).)
Public methodGetDataPresent(String)Indicates whether data stored in the clipboard object can be converted to or is associated with the specified format. (Overrides DataObject.GetDataPresent(String).)
Public methodGetDataPresent(Type)Indicates whether data stored in the clipboard object can be converted to or is associated with the specified format. (Overrides DataObject.GetDataPresent(Type).)
Public methodGetDataPresent(String, Boolean)Indicates whether data stored in the clipboard object can be converted to or is associated with the specified format, using an automatic conversion parameter to determine whether to convert the data to the format. (Overrides DataObject.GetDataPresent(String, Boolean).)
Public methodGetFileDropListRetrieves a collection of file names from the data object. (Inherited from DataObject.)
Public methodGetFormats()Retrieves a list of all formats that are supported for the data stored in the clipboard object. (Overrides DataObject.GetFormats().)
Public methodGetFormats(Boolean)Retrieves a list of all formats that are supported for the data stored in the clipboard object, using an automatic conversion parameter to determine whether to retrieve only native data formats or all formats that the data can be converted to. (Overrides DataObject.GetFormats(Boolean).)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetImageRetrieves an image from the data object. (Inherited from DataObject.)
Public methodGetText()Retrieves text data from the data object in the UnicodeText format. (Inherited from DataObject.)
Public methodGetText(TextDataFormat)Retrieves text data from the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSetAudio(Byte[])Adds a Byte array to the data object in the WaveAudio format after converting it to a Stream. (Inherited from DataObject.)
Public methodSetAudio(Stream)Adds a Stream to the data object in the WaveAudio format. (Inherited from DataObject.)
Public methodSetData(Object)Adds data to the clipboard object. (Overrides DataObject.SetData(Object).)
Public methodSetData(String, Object)Adds data to the clipboard object in the specified format. (Overrides DataObject.SetData(String, Object).)
Public methodSetData(Type, Object)Adds data to the clipboard object, using the specified type as the format. (Overrides DataObject.SetData(Type, Object).)
Public methodSetData(String, Boolean, Object)Adds data to the clipboard object. (Overrides DataObject.SetData(String, Boolean, Object).)
Public methodSetFileDropListAdds a collection of file names to the data object in the FileDrop format. (Inherited from DataObject.)
Public methodSetImageAdds an Image to the data object in the Bitmap format. (Inherited from DataObject.)
Public methodSetText(String)Adds text data to the data object in the UnicodeText format. (Inherited from DataObject.)
Public methodSetText(String, TextDataFormat)Adds text data to the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIDataObject.DAdviseCreates a connection between the clipboard object and an advisory sink. This method is called by an object that supports an advisory sink and enables the advisory sink to be notified of changes in the object's data.
Explicit interface implemetationPrivate methodIDataObject.DAdviseCreates a connection between the clipboard object and an advisory sink. This method is called by an object that supports an advisory sink and enables the advisory sink to be notified of changes in the object's data.
Explicit interface implemetationPrivate methodIDataObject.DUnadviseRemoves a notification connection that has been established.
Explicit interface implemetationPrivate methodIDataObject.DUnadviseRemoves a notification connection that had been previously established.
Explicit interface implemetationPrivate methodIDataObject.EnumDAdviseCreates an object that can be used to enumerate the current advisory connections.
Explicit interface implemetationPrivate methodIDataObject.EnumDAdviseCreates an object that can be used to enumerate the current advisory connections.
Explicit interface implemetationPrivate methodIDataObject.EnumFormatEtcCreates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to IDataObject.GetData or IDataObject.SetData.
Explicit interface implemetationPrivate methodIDataObject.EnumFormatEtcCreates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to IDataObject.GetData or IDataObject.SetData.
Explicit interface implemetationPrivate methodIDataObject.GetCanonicalFormatEtcProvides a standard FORMATETC structure that is logically equivalent to a more complex structure. Use this method to determine whether two different FORMATETC structures return the same data, removing the need for duplicate rendering.
Explicit interface implemetationPrivate methodIDataObject.GetCanonicalFormatEtcProvides a standard FORMATETC structure that is logically equivalent to a more complex structure. Use this method to determine whether two different FORMATETC structures return the same data, removing the need for duplicate rendering.
Explicit interface implemetationPrivate methodIDataObject.GetDataObtains data from a source data object. This method is called by a data consumer. It renders the data described in the specified FORMATETC structure and transfers it through the specified STGMEDIUM structure. The caller then assumes responsibility for releasing the STGMEDIUM structure.
Explicit interface implemetationPrivate methodIDataObject.GetDataObtains data from a source data object. This method is called by a data consumer. It renders the data described in the specified FORMATETC structure and transfers it through the specified STGMEDIUM structure. The caller then assumes responsibility for releasing the STGMEDIUM structure.
Explicit interface implemetationPrivate methodIDataObject.GetDataHereObtains data from a source data object. This method, which is called by a data consumer, differs from the IDataObject.GetData method in that the caller must allocate and free the specified storage medium.
Explicit interface implemetationPrivate methodIDataObject.GetDataHereObtains data from a source data object. This method, which is called by a data consumer, differs from the IDataObject.GetData method in that the caller must allocate and free the specified storage medium.
Explicit interface implemetationPrivate methodIDataObject.QueryGetDataDetermines whether the data object is capable of rendering the data described in the FORMATETC structure. Objects attempting a paste or drop operation can call this method before calling IDataObject.GetData to get an indication of whether the operation will be successful.
Explicit interface implemetationPrivate methodIDataObject.QueryGetDataDetermines whether the data object is capable of rendering the data described in the FORMATETC structure. Objects attempting a paste or drop operation can call this method before calling IDataObject.GetData to get an indication of whether the operation will be successful.
Explicit interface implemetationPrivate methodIDataObject.SetDataTransfers data to the object that implements this method. This method is called by an object that contains a data source.
Explicit interface implemetationPrivate methodIDataObject.SetDataTransfers data to the object that implements this method. This method is called by an object that contains a data source.
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft