ShellDataObjectFormat Class |
Defines a Windows Shell Data Object format in the ShellBoost context.
It also provides general purpose IDataObject utilities.
Inheritance HierarchyNamespace: ShellBoost.Core
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
SyntaxC#
public sealed class ShellDataObjectFormat
The ShellDataObjectFormat type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ConvertedData |
Gets the typed data associated with this data.
For array data (such as file contents corresponding to file descriptors), this will contain array of string (temporary files) or byte[].
Only supported if OnDemandDataFormat property value is null.
|
| Data |
Gets the data associated with this format.
For array data (such as file contents corresponding to file descriptors), this will be null, use ConvertedData instead.
Only supported if OnDemandDataFormat property value is null.
|
| Format |
Gets the format identifier.
|
| Name |
Gets the format name.
|
| OnDemandDataFormat |
Gets the related OnDemandDataFormat instance.
Only valid (not null) if a custom OnDemandDataObject instance was provided on OnGetOnDemandDataObjectEvent.
|
Methods| Name | Description | |
|---|---|---|
  | BuildCF_HDROP |
Builds CF_HDROP as an HGlobal handle.
|
| BuildCF_HDROPAsByteArray |
Builds the CF_HDROP format as a byte array.
|
| BuildCFSTR_SHELLIDLIST |
Builds the CFSTR_SHELLIDLIST format as an HGlobal handle.
|
| BuildCFSTR_SHELLIDLISTAsByteArray |
Builds the CFSTR_SHELLIDLIST format as byte array.
|
| EnumerateFormats |
Enumerates the formats from an IDataIObject.
|
| GetBytes(Object, Int32, NullableInt32, Boolean) |
Gets bytes from an IDataObject.
|
| GetBytes(Object, String, NullableInt32, Boolean) |
Gets bytes from an IDataObject.
|
| GetCF_HDROP |
Gets the CF_HDROP format from an IDataObject.
|
| GetCFSTR_FILECONTENTS |
Gets the CFSTR_FILEDESCRIPTOR and CFSTR_FILECONTENTS from an IDataObject.
|
| GetCFSTR_FILEDESCRIPTOR |
Gets the CFSTR_FILEDESCRIPTOR format from an IDataObject.
|
| GetCFSTR_SHELLIDLIST(Object, Boolean) |
Gets the CFSTR_SHELLIDLIST format from an IDataObject.
|
| GetCFSTR_SHELLIDLIST(Object, ShellItemIdList, Boolean) |
Gets the CFSTR_SHELLIDLIST format from an IDataObject.
|
| GetClipboardFormatName |
Retrieves from the clipboard the name of the specified registered format.
|
| GetNativeDataObject |
Gets A native IDataObject from a .NET object.
|
| GetStream(Object, Int32, NullableInt32, Boolean, Boolean) |
Gets a stream from an IDataObject.
|
| GetStream(Object, String, NullableInt32, Boolean, Boolean) |
Gets a stream from an IDataObject.
|
| ParseCF_HDROPFormatData |
Parses the CF_HDROP format.
|
| ParseCFSTR_DROPDESCRIPTIONFormatData |
Parses the CFSTR_DROPDESCRIPTION format.
|
| ParseCFSTR_FILEDESCRIPTORFormatData |
Parses the CFSTR_FILEDESCRIPTOR format.
|
| ParseCFSTR_SHELLIDLISTFormatData(Byte, Boolean) |
Parses the CFSTR_SHELLIDLIST (CIDA) format.
|
| ParseCFSTR_SHELLIDLISTFormatData(Byte, ShellItemIdList, Boolean) |
Parses the CFSTR_SHELLIDLIST (CIDA) format.
|
| ParseCFSTR_SHELLIDLISTOFFSETFormatData |
Parses the CFSTR_SHELLIDLISTOFFSET format.
|
| ParseDataUsingKnownFormatsT |
Try to parse a clipboard data using known formats.
|
| RegisterClipboardFormat |
Registers a new clipboard format. This format can then be used as a valid clipboard format.
If a registered format with the specified name already exists, a new format is not registered and the return value identifies the existing format.
|
| SetCF_HDROP |
Sets the CF_HDROP format to an IDataObject.
|
| SetCFSTR_FILECONTENTS |
Sets the CFSTR_FILEDESCRIPTOR and CFSTR_FILECONTENTS formats to an IDataObject.
This method may not work completely with data object classes that don't fully implement the native COM IDataObject interface, such as Winforms or WPF ones.
If you want to add multiple contents, use the ShellBoost data object created using ShellDataObject.CreateDataObject().
|
| SetCFSTR_SHELLIDLIST |
Sets the CFSTR_SHELLIDLIST format to an IDataObject.
|
| SetHGlobalFormat(Object, Int32, Byte, Int32, DVASPECT, Boolean) |
Sets a format to an IDataObject using an array of bytes.
|
| SetHGlobalFormat(Object, Int32, IntPtr, Int32, DVASPECT, Boolean) |
Sets a format to an IDataObject using a HGLOBAL object.
|
| SetHGlobalFormat(Object, String, Byte, Int32, DVASPECT, Boolean) |
Sets a format to an IDataObject using an array of bytes.
|
| SetHGlobalFormat(Object, String, IntPtr, Int32, DVASPECT, Boolean) |
Sets a format to an IDataObject using a HGLOBAL object.
|
| SetHGlobalFormat(Object, Int32, String, Encoding, Int32, DVASPECT, Boolean) |
Sets a format to an IDataObject using a string.
|
| SetHGlobalFormat(Object, String, String, Encoding, Int32, DVASPECT, Boolean) |
Sets a format to an IDataObject using a string.
|
| ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
| TryParseDataUsingKnownFormats(String, Byte, Object) |
Try to parse a clipboard data using known formats.
|
| TryParseDataUsingKnownFormats(String, Object, Object) |
Try to parse a clipboard data using known formats.
|
| TryParseDataUsingKnownFormatsT(String, Object, T) |
Try to parse a clipboard data using known formats.
|
Fields| Name | Description | |
|---|---|---|
 | CF_BITMAP |
The CF_BITMAP (2) format.
|
| CF_HDROP |
The CF_HDROP (15) format.
|
| CF_RTF |
The CF_RTF ('Rich Text Format') format.
|
| CF_TEXT |
The CF_TEXT (1) format.
|
| CF_UNICODETEXT |
The CF_UNICODETEXT (13) format.
|
| CFSTR_DROPDESCRIPTION |
The CFSTR_DROPDESCRIPTION ('DropDescription') format.
|
| CFSTR_FILECONTENTS |
The CFSTR_FILECONTENTS ('FileContents') format.
Note in the case of ShellBoost, this format's data does not contains the same data as expected.
Instead, the data is an enumerable of temporary files that can be moved wherever you want.
|
| CFSTR_FILEDESCRIPTORW |
The CFSTR_FILEDESCRIPTOR ('FileGroupDescriptorW') format.
|
| CFSTR_FILENAMEW |
The CFSTR_FILENAME ('FileNameW') format.
|
| CFSTR_INDRAGLOOP |
The CFSTR_INDRAGLOOP ('InShellDragLoop') format.
|
| CFSTR_INETURL |
The CFSTR_INETURLW ('UniformResourceLocatorW') format.
|
| CFSTR_INVOKECOMMAND_DROPPARAM |
The CFSTR_INVOKECOMMAND_DROPPARAM ('InvokeCommand DropParam') format.
|
| CFSTR_LOGICALPERFORMEDDROPEFFECT |
The CFSTR_LOGICALPERFORMEDDROPEFFECT ('Logical Performed DropEffect') format.
|
| CFSTR_PASTESUCCEEDED |
The CFSTR_PASTESUCCEEDED ('Paste Succeeded') format.
|
| CFSTR_PERFORMEDDROPEFFECT |
The CFSTR_PERFORMEDDROPEFFECT ('Performed DropEffect') format.
|
| CFSTR_PREFERREDDROPEFFECT |
The CFSTR_PREFERREDDROPEFFECT ('Preferred DropEffect') format.
|
| CFSTR_SHELLDROPHANDLER |
The CFSTR_SHELLDROPHANDLER ('DropHandlerCLSID') format.
|
| CFSTR_SHELLIDLIST |
The CFSTR_SHELLIDLIST ('Shell IDList Array') format.
|
| CFSTR_SHELLIDLISTOFFSET |
The CFSTR_SHELLIDLISTOFFSET ('Shell Object Offsets') format.
|
| CFSTR_TARGETCLSID |
The CFSTR_TARGETCLSID ('TargetCLSID') format.
|
See Also