Click here to Skip to main content
15,868,164 members
Articles / Desktop Programming / Windows Forms
Article

File Dialog Filter Builder

Rate me:
Please Sign up or sign in to vote.
2.64/5 (4 votes)
31 Jul 2007CPOL 33K   353   12   7
Helper class for building filter string for Windows file dialogs

Introduction

The Windows file dialogs provide the Filter property to specify which kinds of files should be shown in the dialog. The syntax is pretty simple, but there is still scope to make a mistake and "create" a bug (with typo for example).

Using the Code

The FileDialogFilterBuilder class uses the FilterInfo structure for every filter item. The FilterInfo structure contains all information about one filter item. Using these two types are pretty simple and intuitive:

C#
// Create builder
FileDialogFilterBuilder filterBuilder = new FileDialogFilterBuilder();
// add filter item for Word documents
filterBuilder.Infos.Add( new FilterInfo( "Word", "doc", "docx", "rtf" ) );
// add filter item for Excel documents
filterBuilder.Infos.Add( new FilterInfo( "Excel", "xls", "xlsx", "csv" ) );

// create filter item for images
FilterInfo infoImages = new FilterInfo( "Images" );
// these extensions will be used by dialog for filtering files
infoImages.Extensions = new string[] 
	{ "bmp", "jpg", "gif", "jpeg", "png", "wmf", "emf", "ico" };
// these extensions will be displayed to user with item
infoImages.VisibleExtensions = new string[] { "bmp", "jpg", "gif" };
// add item to builder
filterBuilder.Infos.Add( infoImages );

// add item with no-filter, with title "All file types"
filterBuilder.AddAllFileTypes( "All file types" );

using ( OpenFileDialog ofd = new OpenFileDialog() ) {
    // method "ToFilterString()" builds the filter string with correct syntax
    ofd.Filter = filterBuilder.ToFilterString();
    ofd.ShowDialog( this );
} 

That's all.

History

  • 1st August, 2007: Initial post

License

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


Written By
Web Developer
Czech Republic Czech Republic
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
GeneralOrdering and Default Pin
Member 334239818-Aug-09 12:25
Member 334239818-Aug-09 12:25 
GeneralSystem extension description Pin
Chris Richner1-Aug-07 2:06
Chris Richner1-Aug-07 2:06 
GeneralRe: System extension description Pin
Jakub Mller1-Aug-07 2:44
Jakub Mller1-Aug-07 2:44 
AnswerRe: System extension description Pin
Chris Richner1-Aug-07 12:26
Chris Richner1-Aug-07 12:26 
GeneralRe: System extension description Pin
Anthony Daly27-Oct-09 9:46
Anthony Daly27-Oct-09 9:46 
Generalspelling mistake Pin
Michael Sync31-Jul-07 22:27
Michael Sync31-Jul-07 22:27 
GeneralRe: spelling mistake Pin
Jakub Mller31-Jul-07 22:45
Jakub Mller31-Jul-07 22:45 

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

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