Click here to Skip to main content
Click here to Skip to main content

FolderBrowserDialogEx: A C# customization of FolderBrowserDialog

, 18 Feb 2011 CPOL
Rate this:
Please Sign up or sign in to vote.
The FolderBrowserDialogEx class library and a WinForms app that demos it.

Introduction

We've all used FolderBrowserDialog and its precursor SHBrowseForFolder. While these common controls are very useful in stock form, they never quite seem to do exactly what you want - there's always some UI artifact that you really don't want. And, like many things in .NET, the managed API seems to be a thin wrapper around the unmanaged API, and the managed API therefore inherits all the quirks.

I had a few gripes about FolderBrowserDialog, especially:

  • The stock "Browse For Folder" dialog title... I want to say something more informative.
  • There's no option for a path edit box... it's in SHBrowseForFolder but disappeared in FolderBrowserDialog.

Background

In setting out to solve the issues, I started in the usual way: search the Web for code samples! I found two particularly useful samples:

Neither of which was the exact solution I sought, but both provided invaluable starting points. XBrowseForFolder had many of the features I wanted... but it's in C++. PInvoke's SHBrowseForFolder C# sample code provided a glimpse into what's possible in managed code, but is just a snippet. I encourage you to explore both links above as they can provide details that this sample intentionally omits.

Using the Code

XBrowseForFolder does a great job explaining the techniques for using SHBrowseForFolder, so I won't rehash that here. The one semi-messy part of doing it in .NET is the interaction between managed and unmanaged code, specifically connecting to SHBrowseForFolder's callback function. This requires Marshaling and a class - herein named InitData - to pass data from the main function to the callback. I originally tried to pass the class object itself to the callback but that would hang, thus a helper class was necessary.

The attached sample code contains a FolderBrowserDialogEx classlib and a WinForms app that demos it. The classlib's implementation is in FolderBrowserDialogEx.cs; the attendant P/Invoke code is in Win32.cs. The demo app is pretty much boilerplate. The main form, Form1, is designed to look and behave like the demo UI in XBrowseForFolder.

Invoking FolderBrowserDialogEx

The FolderBrowserDialogEx interface mimics that of FolderBrowserDialog:

FolderBrowserDialogEx cfbd = new FolderBrowserDialogEx();
// These are identical to FolderBrowserDialog:
cfbd.SelectedPath = @"c:\";
cfbd.ShowNewFolderButton = true;
cfbd.RootFolder = Environment.SpecialFolder.Desktop;
// These are specific to FolderBrowserDialogEx
cfbd.Title = "Your custom title";
cfbd.ShowEditbox = true;
cfbd.StartPosition = FormStartPosition.CenterScreen;
// Show the UI like any other dialog:
if (cfbd.ShowDialog(this) == DialogResult.OK)
{
    // Retrieve value from cfbd.SelectedPath
}

Points of Interest

Overriding SHBrowseForFolder took a surprising number of P/Invoke APIs. I found that to do a proper job, we must have a good grounding in the pre-.NET world. I found it interesting that the stock FolderBrowserDialog doesn't offer the path editbox but it does offer the "Create New Folder" button. Seems to me that users would often enough want to type or paste a path so as to warrant the inclusion of the editbox.

I was interested and annoyed to find that SHBrowseForFolder's BIF_NEWDIALOGSTYLE makes it really hard to override the stock behavior. In particular, when BIF_NEWDIALOGSTYLE is applied, you absolutely cannot reposition the editbox... some code fights you and puts the editbox where it wants even when you try to put it where you want.

I found XBrowseForFolder to be a blast from the past. It hasn't been that long since unmanaged C++ was my primary environment, but a quick tour through this older code really made me appreciate how elegant C#/WinForms is compared to C++/MFC.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

DLChambers
Software Developer
United States United States
I can type "while" and "for" very quickly

Comments and Discussions

 
QuestionInteract with the contents of the edit box Pinmemberflipdoubt29-May-11 4:43 
AnswerRe: Interact with the contents of the edit box PinmemberDLChambers29-May-11 12:49 
Generalmy vote is 5 PinmemberKendoTM21-Feb-11 20:27 
GeneralRe: my vote is 5 PinmemberClaudio Nicora21-Feb-11 22:56 
GeneralShowNewFolderButton on FolderBrowserDialogEx does not work PinmemberRudolfHenning18-Feb-11 10:23 
GeneralRe: ShowNewFolderButton on FolderBrowserDialogEx does not work PinmemberDLChambers18-Feb-11 11:06 
GeneralRe: ShowNewFolderButton on FolderBrowserDialogEx does not work Pinmemberimgen18-Feb-11 21:28 
GeneralRe: ShowNewFolderButton on FolderBrowserDialogEx does not work Pinmemberflipdoubt31-May-11 7:43 
GeneralRe: ShowNewFolderButton on FolderBrowserDialogEx does not work Pinmemberimgen31-May-11 15:58 
GeneralRe: ShowNewFolderButton on FolderBrowserDialogEx does not work Pinmembercedral27-Apr-12 9:06 
Generalperhaps a screen shot might be good PinmvpSacha Barber18-Feb-11 6:29 
GeneralRe: perhaps a screen shot might be good Pinmembersam.hill18-Feb-11 6:57 
GeneralRe: perhaps a screen shot might be good PinmemberSteve Maier18-Feb-11 6:57 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.141220.1 | Last Updated 18 Feb 2011
Article Copyright 2011 by DLChambers
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid