<

How to Accept Drag-and-Drop Files from Windows Explorer

Published on
20,103 Points
10,403 Views
2 Endorsements
Last Modified:
Awarded
DanRollins
Allow your users to drag from the Explorer rather than navigate a select-a-file or select-a-folder dialog.  This article provides C++ source code that will simplify common data-input operations for your users.  

For instance, if you want the user to identify a list of files to move or delete or view or process, you can allow him to drag files from an Explorer window and drop them onto your input window.  If you need the user to specify a particular folder as a base of operations for output, you can allow him to drop a folder onto your window.
Drop files onto multiline edit boxSimplest Scenario
The simplest implementation requires very little programming.  In this scenario, you need only set up a single message handler and a few lines of code to convert a file-drop into a list of files.

1) Use the App Wizard to create an MFC dialog-based application.

2) In the Dialog Editor, add a multi-line edit box (IDC_EDIT1).

3) Add a message handler for the dialog:  In the Properties of the dialog, select the "Messages" category, click WM_DROPFILES, and select <Add> OnDropFiles.  This puts you in the source code editor.  Make the handler like so:
void CMyDlg::OnDropFiles(HDROP hDropInfo)
{
    CDialog::OnDropFiles( hDropInfo );
    int nCntFiles= DragQueryFile( hDropInfo, -1, 0,0 );

    CEdit* pEd= (CEdit*)GetDlgItem( IDC_EDIT1 );
    for (int j=0; j<nCntFiles; j++ ) {
        char szBuf[MAX_PATH];
        ::DragQueryFile( hDropInfo, j, szBuf, sizeof(szBuf) );
        int iLen= pEd->GetWindowTextLength();
        pEd->SetSel( iLen, iLen );       // position at end of list
        pEd->ReplaceSel( szBuf, TRUE );  // append path and filename
        pEd->ReplaceSel( "\r\n", TRUE ); // ... and line break
    }
}

Open in new window

Note that lines 8-13 could just as easily populate a ListView control or generate lines of HTML for a browser control, or just "silently" fill a CStringArray with filenames.  One thing to watch for:  The user can drop folder icons as well as files.  You can use the PathIsDirectory API function or some other means to differentiate between the two when you process the items.

4) Edit the OnInitDialog() function and put this at the end:
BOOL CMyDlg::OnInitDialog()
...
    ::DragAcceptFiles( m_hWnd, true );
    return TRUE;  
}

Open in new window

Actually, this last step can be accomplished by setting a property of the dialog box (the Accept Files property which sets the WS_EX_ACCEPTFILES style).  You can do it either way or both, but I find that using an explicit line of program code is often the best way to document functionality.

Allow Drop Only on the Target
The above code might not work exactly as desired.  For simplicity, we set up so that the user can drop the file(s) on any part of the parent dialog.  A more likely scenario would be to let the user drop only on the edit box.  The WM_DROPFILES message goes to the window specified in the DragAcceptFiles().  If we specify the edit box in that call, the parent (dialog) window won't get the messages.  

The normal way to handle this to to derive an object from CEdit and do the work in that derived class.  As an option, consider this technique:  Use SubclassDlgItem() to re-route that one message to the dialog object so that all of the handling can be done there.  For instance:

class CEditDropNotif : public CEdit
{
    virtual BOOL PreTranslateMessage(MSG* pMsg) {
        if ( pMsg->message == WM_DROPFILES ) {
            GetParent()->SendMessage(WM_DROPFILES, pMsg->wParam, pMsg->lParam);
            return TRUE; // eat it
        }
        return FALSE; // allow default processing
    }
};
BOOL CMyDlg::OnInitDialog()
{
 ...
    static CEditDropNotif cEd;  // must persist (usually a dlg member)
    cEd.SubclassDlgItem( IDC_EDIT1, this );
    ::DragAcceptFiles( cEd.m_hWnd, true );  // the editbox, not the dialog
 ...

Open in new window

With that code in place, the drag-and-drop visual feedback works more as expected -- the "Don't Drop" cursor changes into a "Drop OK" cursor only while dragging over the edit box.  You might use a similar technique in this common layout, Drop as an additional input option...where you allow a user to either type in, paste, or browse for a folder... You give him one more option: Drag a folder from any Explorer window.

The More Complicated Scenario
The Simplest Scenario described above is all that's needed to give your program the basic drop-from-Explorer capability.  If you read the MSDN documentation, you might wonder why they make it seem so complicated.  Well. they have to explain how to be a drop source, which we are omitting here, but also they need to cover the underlying handling that is less often needed.  

In the more complicated variation, you must create an IDropTarget object and call RegisterDragDrop(). This technique provides additional flexibility; in particular, you can work with the contents of the dragged object, rather than just the filename.

For instance, using this technique, you can determine in advance if a dropped "file" is actually a directory.  And you can handle a drop of all kinds of shell objects, such as printers, computers, and various "shell namespace" objects.

You can control the cursor -- to provide specialized feedback to the user while he drags over various parts of your U/I.  And you can know whether the user is pressing SHIFT or ALT or CTRL while he is dragging -- also to provide specialized feedback.

You can also customize the "right-drag" context menu; that is, the menu that appears when the user presses the right-side mouse button when doing the drag.  Upon the "right-drop" (releasing the mouse button over your app), you can decide what, if any, special options you want to allow.

This article will NOT go into depth on all of these options; most of them are rarely needed.  However, the next example does illustrate how to set up a drop target and how to take action during the drag.

If your application hosts a Tree control, you may want to accept drops of files from the Explorer onto nodes in the tree; that is, dropping onto the tree control is not enough... you need to allow the user to specify a particular node, or branch, of the tree... as he drags.
Accept file drops onto a Tree ControlIn this example, we assume that you have CTreeCtrl object named m_ctlTree on your dialog and that it is populated with a set of folders... they could be task groups, or holding bins, or whatever.  You want to accept files dragged from the Explorer into these buckets.  I don't want to complicate the example any more than needed, so I won't show how to set the ImageList for the tree or other (usually essential) coding.

As (nearly) always, the designers of MFC have provided plenty of useful tools to simplify our task.  We will derive from from COleDropTarget, which takes care of all of the overhead.  All we need to do is provide a handler for OnDragOver() and OnDrop():
// file: MyDropTarget.h
//
class CMyDropTarget : public COleDropTarget
{
public:
    virtual DROPEFFECT OnDragOver(CWnd* pWnd, COleDataObject* pDataObject,
                DWORD dwKeyState, CPoint point) 
    {
        CTreeCtrl* pTree= (CTreeCtrl*)pWnd;
        UINT nFlags;
        HTREEITEM hitem= pTree->HitTest( point, &nFlags );
        if ( hitem != NULL) {
            DWORD nItemData= pTree->GetItemData( hitem ); 
            if ( (nItemData & 1) == 0 ) {          // it's a folder item
                pTree->SelectDropTarget( hitem );
                pTree->Expand(hitem,TVE_EXPAND );
                return( DROPEFFECT_LINK );
            }
        }
     return( DROPEFFECT_NONE ); //else, show the "Don't Drop" pointer
    };
    virtual BOOL OnDrop(CWnd* pWnd, COleDataObject* pDataObject, 
                DROPEFFECT dropEffect, CPoint point) {
        if ( dropEffect == DROPEFFECT_LINK ) {
            CTreeCtrl* pTree= (CTreeCtrl*)pWnd;
            STGMEDIUM rSM;
            BOOL fRet= pDataObject->GetData( CF_HDROP, &rSM, 0 );

            HDROP hDropInfo= (HDROP)rSM.hGlobal;
            HTREEITEM hDropItem= pTree->GetDropHilightItem();

            int nCntFiles= DragQueryFile( hDropInfo, -1, 0,0 );
            for ( int j=0; j<nCntFiles; j++ ) {
                char szBuf[MAX_PATH];
                ::DragQueryFile( hDropInfo, j, szBuf, sizeof(szBuf) );
                HTREEITEM hNew= pTree->InsertItem( szBuf, hDropItem );
                pTree->SetItemData( hNew, 1 );   // indicate not a folder
            }
            pTree->Expand( hDropItem,TVE_EXPAND ); // show the dropped items
        }
        return( 1 ); // success
    };
};  // end of class CMyDropTarget

Open in new window

The OnDragOver() function will be called on mouse movements that are over the registered target -- the tree control.  All we need to do is determine whether a drop should or should not be allowed.  Line 12 calls the tree control's HitTest() function to learn which, if any, tree node is below the mouse cursor.  When a node is there, we make an additional test to see that node is a valid drop target.  In this case, I just check the item data of the node.  If it has been set to 1, then it is a leaf node (a previously-dropped file) and is not eligible as a drop target.  As you drag over these elements, the cursor automatically switches between "Don't Drop" and "Drop OK").

In the OnDrop() function, we get the same kind of hDropInfo handle that we used in the Simplest Scenario example, and we use a similar series of steps to process each of the dropped items.  For each file, we use InsertItem() to add the item below the drop-target parent node, and we use the SetItemData() function to flag each as a "leaf" node so that it will not be considered as a drop target later on.

Using CMyDropTarget:
To use the COleDropTarget-derived object, just #include the header in the dialog object and declare an instance of it.  Then in InitDialog(),  call its Register member -- which ends up calling RegisterDragDrop() to set up the tree control for dragging operations.  For instance:
CMyDropTarget gcMyTreeDropTarget; // declare the object

BOOL CMyDlg::OnInitDialog()
{
    CDialog::OnInitDialog();
...
    HRESULT hr= OleInitialize( 0 );   // <<<---- note: Required!
    gcMyTreeDropTarget.Register( &m_ctlTree );
...

Open in new window

Also note the OleInitialize() call.   You would typically do that elsewhere, such as in InitInstance(), but I wanted to show it explicitly here.  The call is required to initialize the OLE drag-and-drop support.

How to display a Windows Explorer
Since your user will be dragging from the Windows Explorer, you might want to make his task a little easier by providing a means to pop up an Explorer window for him -- preset, perhaps, to show a particular default directory.  Here's how to do that:

ShellExecute( NULL, "explore",         
    "c:\\My Documents\\WonderProg\\Data\\TaskTemplates", // any folder name
    NULL,      
    NULL,      
    SW_SHOWNORMAL 
);

Open in new window

You could use the open verb, but the explore verb shows the folder in two-pane Explorer mode -- with the tree on the left for easy navigation.

References:

Handling Shell Data Transfer Scenarios
http://msdn.microsoft.com/en-gb/library/bb776904(VS.85).aspx

CTreeCtrl Class (MFC)
http://msdn.microsoft.com/en-us/library/8bkz91b4(VS.80).aspx

COleDropTarget Class (MFC)
http://msdn.microsoft.com/en-us/library/4w4z9dwh.aspx

Shell Clipboard Formats
http://msdn.microsoft.com/en-us/library/bb776902(VS.85).aspx

See Also:

How to Accept Drag-and-Drop URLs From a Web Browser

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
If you liked this article and want to see more from this author,  please click the Yes button near the:
      Was this article helpful?
label that is just below and to the right of this text.   Thanks!
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
2
Comment
Author:DanRollins
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
0 Comments

Featured Post

[Webinar] Code, Load, and Grow

Managing multiple websites, servers, applications, and security on a daily basis? Join us for a webinar on May 25th to learn how to simplify administration and management of virtual hosts for IT admins, create a secure environment, and deploy code more effectively and frequently.

Join & Write a Comment

This is Part 3 in a 3-part series on Experts Exchange to discuss error handling in VBA code written for Excel. Part 1 of this series discussed basic error handling code using VBA. http://www.experts-exchange.com/videos/1478/Excel-Error-Handlin…

Keep in touch with Experts Exchange

Tech news and trends delivered to your inbox every month