What is the difference between the new TFileOpenDialog and the old TOpenDialog?

delphi windows-7 windows-vista fileopendialog opendialog

10,415

Solution 1

TOpenDialog wraps the traditional GetOpenFileName. It works on all versions of Windows.
TFileOpenDialog wraps the new COM based dialog that was introduced in Vista. It therefore only works on Vista or later. It has more functionality than the older dialogs, most notably the tight integration with search.

Vista common dialog

Compatibility common dialog

The GetOpenFileName API will in fact produce the new dialogs in most situations, if called correctly, so you can't actually tell the difference. That said, historically the VCL's wrapper for GetOpenFileName was implemented imprecisely and always resulted in the compatibility dialog being shown.

But what does the new COM dialog have to offer then?

The new dialog offers a much easier customisation interface at the loss of some generality. If you use the old dialog template based customisation with GetOpenFileName on Vista or later then the dialogs degrade to ugly compatibility versions that lack functionality.

The other big advantage of the new dialogs is the ability to select unlimited number of files. The old GetOpenFileName interface returned multi-select filenames in a fixed size buffer. This can be a real limitation and in my own code I have had to hack the VCL code to make this buffer larger for when my app runs on XP.

TOpenDialog will delegate the work to TFileOpenDialog if possible. The test it uses requires all of the following to be true:

Running on Windows Vista or later.
Dialogs.UseLatestCommonDialogs global boolean variable is true (default is true). This allows you to disable the use of the new COM dialog should you elect to do so.
No dialog template is specified.
OnIncludeItem, OnClose and OnShow events are all not assigned. Presumably these cannot be fired by TFileOpenDialog.

Summary

If you continue to use TOpenDialog then you will reap the benefit of unlimited number of file in multi-select mode. However, if you wish to customise the dialog, and have the new dialogs rather than the ugly compatibilty dialogs, then you need to do the following:

On XP use TOpenDialog and the dialog template method.
On Vista and later use TFileOpenDialog and implement customisation with IFileDialogCustomize.

Solution 2

TOpenDialog executes TFileOpenDialog when the following conditions are met:

the program is running under Vista (and up)
UseLatestCommonDialogs is true (which is the default)
no OnIncludeItem, OnClose or OnShow events are set

So while still using TOpenDialog on your system you may likely end up automagically executing TFileOpenDialog in most cases, which explains why they are looking the same for you.

Remark: TFileOpenDialog does not fall back on older Windows systems (XP and under) - it just raises an exception. On the opposite, TOpenDialog does some sort of "fall forward".

10,415

Server Overflow

References List of Delphi language features and version in which they were introduced/deprecated Should we finally move from Delphi to Lazarus? POLL: http://www.quiz-maker.com/QOLJI03 Goodbye Delphi! March 2020 headline: Delphi is about to fall out of the TIOBE index top 20 https://www.tiobe.com/tiobe-index/ Jan 2022 Delphi is climbing back towards Top10. Embarcadero did a good job with its Community license. My SO rule: I up vote any (half-decent) SO question that was down voted, and no reason was provided for the down vote !!!! The decline of StackOverflow: https://hackernoon.com/the-decline-of-stack-overflow-7cb69faa575d Randomly deleted questions on SO: https://sergworks.wordpress.com/2012/09/26/why-stackoverflow-sucks/ Delphi is 2nd most hated language. Congrats Embarcadero! https://stackoverflow.blog/2017/10/31/disliked-programming-languages/ Why Borland failed? The Borland Turbo languages where the Cat's Pajamas. Microsoft countered with the Quick languages. Borland made Turbo Pascal for Windows and with Objects and then made Delphi. Microsoft countered with Visual BASIC. Borland made Borland C++ and JBuilder. Microsoft countered with Visual C++ and Visual J++/J# and then later Visual C#. The free IDEs and Free compiler languages ate into Borland's sales. Eclipse, Netbeans, IntelliJ, BlueJ, Sublime Text, GNU C/C++, Apple XCode, FreePascal/Lazarus, Ruby/Ruby on Rails, Python, Code::Blocks, etc. In 2005 Microsoft introduce Visual Studio Express a free version of their development tools. Like Amiga, Borland had the superior technology, but cheaper/free alternatives undercut their sales. Mostly, it was the free and open source revolution that did Borland in. orionblastar

Updated on January 28, 2021

Comments

Server Overflow over 3 years

What is the difference between the new TFileOpenDialog and the old TOpenDialog?
In my computer (Win 7/DXE), when I run the code, the dialogs look the same.
- GolezTrol almost 13 years
  
  TFileOpenDialog implements Vista style open dialogs, but falls back to older style in previous versions of Windows.
- Uwe Raabe almost 13 years
  
  @GolezTrol, TFileOpenDialog raises an Exception when run under XP.
- GolezTrol almost 13 years
  
  @Uwe Raabe. Can't test it, but I believe you're right. My mistake.
Andreas Rejbrand almost 13 years

Wait a minute, you and Uwe contradict each other. I remove the +1 but will restore it as soon as the issue is settled... I just checked, and Uwe is right.
David Heffernan almost 13 years

@Andreas OK, I think it's fixed now.
David Heffernan almost 13 years

A couple of very minor gripes: 1) You missed any reference to the dialog template which should have appeared in your bullet points. 2) GetOpenFileName also usually results in the shiny new dialogs, so long as it is called in a particular way. I'm not actually sure whether or not modern versions of the VCL call GetOpenFileName in the appropriate fashion but this is somewhat moot now that TFileOpenDialog is used behind the scenes.
Uwe Raabe almost 13 years

@David Heffernan, I actually looked at the Template property, but as it is protected and never set in the standard dialog components I decided to omit it here. Otherwise I would have to explain how to use it.
Sertac Akyuz almost 13 years

If I recall correct it was not imprecision on VCL's part, but the ever changing OPENFILENAME struct. VCL, being compatible with earlier OS versions, declared the smaller struct which resulted older dialogs to be shown. I may be wrong though..
David Heffernan almost 13 years

Template is protected? I didn't realise that but I use my own wrappers rather than the VCL ones. The thing is though that dialog customisation is the main issue that leads you to use TFileOpenDialog.
Server Overflow almost 13 years

So, the wise action will be to use the 'old' TOpenDialog in order to get compatibility with XP and 7. Thanks. +1 and accepted.
oxo about 12 years

In Delphi XE2, there is another condition: StyleServices.Enabled must be true. Does anybody know why??? I use Win 7 with old styles, why are new dialogs disabled???
David Heffernan about 12 years

@oxo That's a bug in the VCL. There are a number of similar bugs. That's one reason why I use my own wrappers to the system file dialogs. Same error was made with the task dialog wrapper. VCL coders not good enough.
oxo about 12 years

Thanks for the confirmation. I thought it did not make any sense to disable vista dialogs just because of disabled styles.
David Heffernan over 11 years

@SertacAkyuz In fact it's down to the setting of OpenFilename.Flags := OFN_ENABLEHOOK in TOpenDialog.DoExecute. I guess that's needed in order to handle events. So that charge of imprecision is too harsh.