This document is archived and information here might be outdated.  Recommended version.


IDataObjectHelper.GetFormat Method (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > SystemUI > ESRI.ArcGIS.SystemUI > Interfaces > ID > IDataObjectHelper Interface > IDataObjectHelper.GetFormat Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (SystemUI)  

IDataObjectHelper.GetFormat Method

Indicates if the DataObject supports the specified format.

[Visual Basic .NET]
Public Function GetFormat ( _
    ByVal format As Integer _
) As Boolean

[C#]
public bool GetFormat (
    int format
);

[C++]
HRESULT GetFormat(
  long format,
  VARIANT_BOOL* pbFormatSupported
);

[C++]

Parameters
format [in]
  format is a parameter of type long
pbFormatSupported [out, retval]
  pbFormatSupported is a parameter of type VARIANT_BOOL

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

GetFormat returns the DataObject format code. The format code corresponds to a clipboard format that is unqiue to the system and is registered with the windows api function RegisterClipboardFormat. Other standard drag and drop formats are available. For example, 1 is used for text, 2 for a bitmap and 15 is used for a file list.

Use to test if the format of data in the DataObject matches the specified format. Typically used when dropping data onto the PageLayoutControl and MapControl from other applications.

See Also

IDataObjectHelper Interface