ClipboardObject Class

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

Inheritance Hierarchy

System.Object
  System.Windows.Forms.DataObject
    Microsoft.VisualStudio.Data.Framework.ClipboardObject
      Microsoft.VisualStudio.Data.Framework.DSRefClipboardObject

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

Syntax

'Declaration
Public Class ClipboardObject _
    Inherits DataObject _
    Implements IDataObject, IDataObject

public class ClipboardObject : DataObject, 
    IDataObject, IDataObject

public ref class ClipboardObject : public DataObject, 
    IDataObject, IDataObject

type ClipboardObject =  
    class 
        inherit DataObject 
        interface IDataObject 
        interface IDataObject 
    end

public class ClipboardObject extends DataObject implements IDataObject, IDataObject

The ClipboardObject type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	ContainsAudio	Indicates whether the data object contains data in the WaveAudio format. (Inherited from DataObject.)
	ContainsFileDropList	Indicates whether the data object contains data that is in the FileDrop format or can be converted to that format. (Inherited from DataObject.)
	ContainsImage	Indicates whether the data object contains data that is in the Bitmap format or can be converted to that format. (Inherited from DataObject.)
	ContainsText()	Indicates whether the data object contains data in the UnicodeText format. (Inherited from DataObject.)
	ContainsText(TextDataFormat)	Indicates whether the data object contains text data in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAudioStream	Retrieves an audio stream from the data object. (Inherited from DataObject.)
	GetData(String)	Retrieves the data stored in the clipboard object in the specified format. (Overrides DataObject.GetData(String).)
	GetData(Type)	Retrieves the data stored in the clipboard object in the specified format. (Overrides DataObject.GetData(Type).)
	GetData(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).)
	GetDataPresent(String)	Indicates whether data stored in the clipboard object can be converted to or is associated with the specified format. (Overrides DataObject.GetDataPresent(String).)
	GetDataPresent(Type)	Indicates whether data stored in the clipboard object can be converted to or is associated with the specified format. (Overrides DataObject.GetDataPresent(Type).)
	GetDataPresent(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).)
	GetFileDropList	Retrieves a collection of file names from the data object. (Inherited from DataObject.)
	GetFormats()	Retrieves a list of all formats that are supported for the data stored in the clipboard object. (Overrides DataObject.GetFormats().)
	GetFormats(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).)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetImage	Retrieves an image from the data object. (Inherited from DataObject.)
	GetText()	Retrieves text data from the data object in the UnicodeText format. (Inherited from DataObject.)
	GetText(TextDataFormat)	Retrieves text data from the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetAudio(array<Byte[])	Adds a Byte array to the data object in the WaveAudio format after converting it to a Stream. (Inherited from DataObject.)
	SetAudio(Stream)	Adds a Stream to the data object in the WaveAudio format. (Inherited from DataObject.)
	SetData(Object)	Adds data to the clipboard object. (Overrides DataObject.SetData(Object).)
	SetData(String, Object)	Adds data to the clipboard object in the specified format. (Overrides DataObject.SetData(String, Object).)
	SetData(Type, Object)	Adds data to the clipboard object, using the specified type as the format. (Overrides DataObject.SetData(Type, Object).)
	SetData(String, Boolean, Object)	Adds data to the clipboard object. (Overrides DataObject.SetData(String, Boolean, Object).)
	SetFileDropList	Adds a collection of file names to the data object in the FileDrop format. (Inherited from DataObject.)
	SetImage	Adds an Image to the data object in the Bitmap format. (Inherited from DataObject.)
	SetText(String)	Adds text data to the data object in the UnicodeText format. (Inherited from DataObject.)
	SetText(String, TextDataFormat)	Adds text data to the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IDataObject.DAdvise	Creates 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.
	IDataObject.DAdvise	Creates 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.
	IDataObject.DUnadvise	Removes a notification connection that has been established.
	IDataObject.DUnadvise	Removes a notification connection that had been previously established.
	IDataObject.EnumDAdvise	Creates an object that can be used to enumerate the current advisory connections.
	IDataObject.EnumDAdvise	Creates an object that can be used to enumerate the current advisory connections.
	IDataObject.EnumFormatEtc	Creates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to IDataObject.GetData or IDataObject.SetData.
	IDataObject.EnumFormatEtc	Creates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to IDataObject.GetData or IDataObject.SetData.
	IDataObject.GetCanonicalFormatEtc	Provides 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.
	IDataObject.GetCanonicalFormatEtc	Provides 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.
	IDataObject.GetData	Obtains 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.
	IDataObject.GetData	Obtains 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.
	IDataObject.GetDataHere	Obtains 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.
	IDataObject.GetDataHere	Obtains 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.
	IDataObject.QueryGetData	Determines 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.
	IDataObject.QueryGetData	Determines 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.
	IDataObject.SetData	Transfers data to the object that implements this method. This method is called by an object that contains a data source.
	IDataObject.SetData	Transfers data to the object that implements this method. This method is called by an object that contains a data source.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Data.Framework Namespace