OleDataObject Class

  • Article

Provides a managed class that implements the IOleDataObject interface.

Inheritance Hierarchy

System.Object
  System.Windows.Forms.DataObject
    Microsoft.VisualStudio.Shell.OleDataObject

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Syntax

'Declaration
Public Class OleDataObject _
    Inherits DataObject _
    Implements IDataObject

public class OleDataObject : DataObject, 
    IDataObject

public ref class OleDataObject : public DataObject, 
    IDataObject

type OleDataObject =  
    class 
        inherit DataObject 
        interface IDataObject 
    end

public class OleDataObject extends DataObject implements IDataObject

The OleDataObject type exposes the following members.

Constructors

  Name Description
Public method OleDataObject() Initializes a new instance of OleDataObject.
Public method OleDataObject(IDataObject) Initializes a new instance of OleDataObject for the specified IDataObject.
Public method OleDataObject(IDataObject) Initializes a new instance of OleDataObject for the specified IDataObject.
Public method OleDataObject(IDataObject) Initializes a new instance of OleDataObject for the specified object implementing IDataObject.

Top

Methods

  Name Description
Public method ContainsAudio Indicates whether the data object contains data in the WaveAudio format. (Inherited from DataObject.)
Public method ContainsFileDropList Indicates whether the data object contains data that is in the FileDrop format or can be converted to that format. (Inherited from DataObject.)
Public method ContainsImage Indicates whether the data object contains data that is in the Bitmap format or can be converted to that format. (Inherited from DataObject.)
Public method ContainsText() Indicates whether the data object contains data in the UnicodeText format. (Inherited from DataObject.)
Public method ContainsText(TextDataFormat) Indicates whether the data object contains text data in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAudioStream Retrieves an audio stream from the data object. (Inherited from DataObject.)
Public method GetData(String) Returns the data associated with the specified data format. (Inherited from DataObject.)
Public method GetData(Type) Returns the data associated with the specified class type format. (Inherited from DataObject.)
Public method GetData(String, Boolean) Returns the data associated with the specified data format, using an automated conversion parameter to determine whether to convert the data to the format. (Inherited from DataObject.)
Public method GetDataPresent(Type) Determines whether data stored in this DataObject is associated with, or can be converted to, the specified format. (Inherited from DataObject.)
Public method GetDataPresent(String) Determines whether data stored in this DataObject is associated with, or can be converted to, the specified format. (Inherited from DataObject.)
Public method GetDataPresent(String, Boolean) Determines whether this DataObject contains data in the specified format or, optionally, contains data that can be converted to the specified format. (Inherited from DataObject.)
Public method GetFileDropList Retrieves a collection of file names from the data object. (Inherited from DataObject.)
Public method GetFormats() Returns a list of all formats that data stored in this DataObject is associated with or can be converted to. (Inherited from DataObject.)
Public method GetFormats(Boolean) Returns a list of all formats that data stored in this DataObject is associated with or can be converted to, using an automatic conversion parameter to determine whether to retrieve only native data formats or all formats that the data can be converted to. (Inherited from DataObject.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetImage Retrieves an image from the data object. (Inherited from DataObject.)
Public method GetText() Retrieves text data from the data object in the UnicodeText format. (Inherited from DataObject.)
Public method GetText(TextDataFormat) Retrieves text data from the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetAudio(array<Byte[]) Adds a Byte array to the data object in the WaveAudio format after converting it to a Stream. (Inherited from DataObject.)
Public method SetAudio(Stream) Adds a Stream to the data object in the WaveAudio format. (Inherited from DataObject.)
Public method SetData(Object) Adds the specified object to the DataObject using the object type as the data format. (Inherited from DataObject.)
Public method SetData(String, Object) Adds the specified object to the DataObject using the specified format. (Inherited from DataObject.)
Public method SetData(Type, Object) Adds the specified object to the DataObject using the specified type as the format. (Inherited from DataObject.)
Public method SetData(String, Boolean, Object) Adds the specified object to the DataObject using the specified format and indicating whether the data can be converted to another format. (Inherited from DataObject.)
Public method SetFileDropList Adds a collection of file names to the data object in the FileDrop format. (Inherited from DataObject.)
Public method SetImage Adds an Image to the data object in the Bitmap format. (Inherited from DataObject.)
Public method SetText(String) Adds text data to the data object in the UnicodeText format. (Inherited from DataObject.)
Public method SetText(String, TextDataFormat) Adds text data to the data object in the format indicated by the specified TextDataFormat value. (Inherited from DataObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IDataObject.DAdvise Infrastructure. Creates a connection between a data 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. (Inherited from DataObject.)
Explicit interface implemetationPrivate method IDataObject.DUnadvise Infrastructure. Destroys a notification connection that had been previously established. (Inherited from DataObject.)
Explicit interface implemetationPrivate method IDataObject.EnumDAdvise Infrastructure. Creates an object that can be used to enumerate the current advisory connections. (Inherited from DataObject.)
Explicit interface implemetationPrivate method IDataObject.EnumFormatEtc Infrastructure. Creates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to GetData or SetData. (Inherited from DataObject.)
Explicit interface implemetationPrivate method IDataObject.GetCanonicalFormatEtc Infrastructure. Provides a standard FORMATETC structure that is logically equivalent to a more complex structure. Use this method to determine whether two different FORMATETC structures would return the same data, removing the need for duplicate rendering. (Inherited from DataObject.)
Explicit interface implemetationPrivate method IDataObject.GetData Infrastructure. Obtains data from a source data object. The GetData method, which is called by a data consumer, 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. (Inherited from DataObject.)
Explicit interface implemetationPrivate method IDataObject.GetDataHere Infrastructure. Obtains data from a source data object. This method, which is called by a data consumer, differs from the GetData method in that the caller must allocate and free the specified storage medium. (Inherited from DataObject.)
Explicit interface implemetationPrivate method IDataObject.DAdvise Establishes a connection between the data object and a caller object implementing IAdviseSink.
Explicit interface implemetationPrivate method IDataObject.DUnadvise Terminates an advise connection previously established through DAdvise.
Explicit interface implemetationPrivate method IDataObject.EnumDAdvise Creates an enumerator to iterate through the current advisory connections.
Explicit interface implemetationPrivate method IDataObject.EnumFormatEtc Creates an enumerator to iterate through the FORMATETC structures supported by the data object.
Explicit interface implemetationPrivate method IDataObject.GetCanonicalFormatEtc Retrieves a FORMATETC structure that is logically equivalent to one that is more complex.
Explicit interface implemetationPrivate method IDataObject.GetData Transfers data from the data object to the client. The pformatetcIn parameter must specify a storage medium type of TYMED_MFPICT.
Explicit interface implemetationPrivate method IDataObject.GetDataHere Transfers data from the data object to the client. The client must allocate the STGMEDIUM structure.
Explicit interface implemetationPrivate method IDataObject.QueryGetData Determines whether the data object supports a particular FORMATETC structure for transferring data.
Explicit interface implemetationPrivate method IDataObject.SetData Transfers data from the client to the data object.
Explicit interface implemetationPrivate method IDataObject.QueryGetData Infrastructure. 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 GetData to get an indication of whether the operation may be successful. (Inherited from DataObject.)
Explicit interface implemetationPrivate method IDataObject.SetData Infrastructure. Transfers data to the object that implements this method. This method is called by an object that contains a data source. (Inherited from DataObject.)

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.Shell Namespace