method ExDataObject.GetFormat (Format as Integer)

Returns a value indicating whether the ExDataObject's data is of the specified format.

TypeDescription
Format as Integer A constant or value that specifies a clipboard data format like described in exClipboardFormatEnum enum.
ReturnDescription
BooleanA boolean value that indicates whether the ExDataObject's data is of specified format.

Use the GetFormat property to verify if the ExDataObject's data is of a specified clipboard format. The GetFormat property retrieves True, if the ExDataObject's data format matches the given data format.

The following VB sample inserts the names of the files being dragged at the cursor position:

Private Sub HTML1_OLEDragDrop(ByVal Data As EXHTMLLibCtl.IExDataObject, Effect As Long, ByVal Button As Integer, ByVal Shift As Integer, ByVal X As Single, ByVal Y As Single)
    If (Data.GetFormat(exCFFiles)) Then
        With Data.Files
            Dim i As Long, s As String
            s = ""
            For i = 0 To .Count - 1
                s = s + .Item(i) + vbCrLf
            Next
            HTML1.SelText = s
        End With
    End If
End Sub

The following C++ sample inserts the names of the files being dragged at the cursor position:

void OnOLEDragDropHTML1(LPDISPATCH Data, long FAR* Effect, short Button, short Shift, long X, long Y) 
{
	if ( EXHTMLLib::IExDataObjectPtr spData( Data ) )
		if ( spData->GetFormat( EXHTMLLib::exCFFiles ) )
		{
			EXHTMLLib::IExDataObjectFilesPtr spFiles = spData->Files;
			if ( spFiles != NULL )
			{
				CString s;
				for ( long i = 0; i < spFiles->Count; i++ )
					s += spFiles->Item[i];
				m_html.SetSelText( s );
			}
		}
}

the sample needs to include definitions for IExDataObject and IExDataObjectFiles objects, by using the #import <exhtml.dll> statement. The #import <exhtml.dll> includes the EXHTMLLib namespace where are defined all objects in the control's type library.

The following VB.NET sample inserts the names of the files being dragged at the cursor position:

Private Sub AxHTML1_OLEDragDrop(ByVal sender As Object, ByVal e As AxEXHTMLLib._IHTMLEvents_OLEDragDropEvent) Handles AxHTML1.OLEDragDrop
    If (e.data.GetFormat(EXHTMLLib.exClipboardFormatEnum.exCFFiles)) Then
        With e.data.Files
            Dim i As Long, s As String = ""
            For i = 0 To .Count - 1
                s = s + .Item(i) + vbCrLf
            Next
            AxHTML1.SelText = s
        End With
    End If
End Sub

The following C# sample inserts the names of the files being dragged at the cursor position:

private void axHTML1_OLEDragDrop(object sender, AxEXHTMLLib._IHTMLEvents_OLEDragDropEvent e)
{
	if (e.data.GetFormat(Convert.ToInt16(EXHTMLLib.exClipboardFormatEnum.exCFFiles)))
	{
		EXHTMLLib.IExDataObjectFiles files = e.data.Files;
		if (files != null)
		{
			string s = "";
			for (int i = 0; i < files.Count; i++)
				s += files[i] + "\r\n";
			axHTML1.SelText = s;
		}
	}
}

The following VFP sample inserts the names of the files being dragged at the cursor position:

*** ActiveX Control Event ***
LPARAMETERS data, effect, button, shift, x, y

if ( data.GetFormat( 15 ) ) then 
	local i, s
	s = ""
	with data.Files
	for i = 0 to .Count - 1
		s = s + .Item(i) + chr(13) + chr(10)
	next
	thisform.HTML1.SelText = s
	endwith
endif