The open file/folder dialog box is a great way to receive input for your scripts interactively. It provides a file browser that makes for a much more user-friendly approach than merely prompting for a path. In this post I show you how can use OpenFileDialog in your PowerShell scripts.

When you're using a Windows application and need to provide input for a file or folder, you've probably seen the standard open file dialog.

Open file dialog

Open file dialog

This dialog box is standard across lots of Windows applications. The software you're using to invoke this dialog box uses a .NET assembly called System.Windows.Forms with a class inside called OpenFileDialog. Did you know you can get input to your PowerShell scripts this way too? Since PowerShell lies directly on top of .NET, we can invoke any .NET class we need, which means we can also bring up the open file dialog box.

To do this, we'll first need to load the System.Windows.Forms assembly manually using the Add-Type cmdlet. Lots of .NET assemblies are typically loaded for you, but in this case, we have to do it manually.

Once we've loaded the assembly, we can instantiate an OpenFileDialog object using New-Object.

You can see above that the OpenFileDialog class constructor has an InitialDirectory argument. This tells the OpenFileDialog class which folder to display when the dialog box comes up. In this case, I have the dialog box to display the desktop.

At this point, the dialog box will not display. We're just instantiating the object. To show the dialog box, we'll have to use the ShowDialog() method.

This will display the dialog box. I'm assigning the output of ShowDialog() to $null. This is because the output does not return anything useful for our purposes. You might expect the output to return the chosen file name, but it doesn't. The system then stores the file information in the OpenFileDialog object itself.

You can see above that the OpenFileDialog object now contains all the information gathered from the file chosen.

The above example allows me to choose any file we'd like, but we also can limit the input by file type too using the Filter property.

Now when the dialog box displays, you can see below that the only options are to choose between Word and Excel documents.

Filtering by file

Filtering by file

For more information about this method of receiving file location input from users, refer to the Microsoft MSDN information.

Join the 4sysops PowerShell group!

Your question was not answered? Ask in the forum!

7+

Users who have LIKED this post:

  • avatar
  • avatar
  • avatar
Share
14 Comments
  1. Jimmy 2 years ago

    Nice article 🙂

    0

  2. matt gallagher 2 years ago

    Thanks for an insight into some of the .net classes that PS can utilise (coming from a non dev. background) - keep it coming!

    0

  3. Allan Weaver 2 years ago

    Good article, but I can't see the filtered file display at the bottom.

     

    0

  4. Shawn 5 months ago

    Is it possible to add a msg? Like: "Please choose the required file..."

    1+

    • Yes, by using the Title property, example below:

       

      0

  5. Sondre Sætervadet 4 months ago

    Hey

    The file i select when i can choose a file wont open when i press open

    0

  6. Sondre - the dialog is just going to give you the name of the file, and that's it.  It doesn't *do* anything with it, that is up to you and your code. Your code needs to take the file and do whatever with it.  

    If you use a ShellExecute method or anything that will call the default verbs, it will run whatever program is associated with that file type, using the command string defined in the file association passing the file name to that string.  So.. if you pick a .docx, and use the default exec, it will launch Word and feed in the file you picked.  If there isn't a file association for that type, you will get the Windows prompt to pick a program to run for that file.

    David F. 

    0

  7. dunca 4 months ago

    thanks man very very nice article, and good job 

    0

  8. Stevie 3 months ago

    Great article - this just enhanced a script I wrote 10mins ago.

    I'm immediately looking to see if there is a CreateFileDialog object type too - excellent for those scripts which need output, and we don't want to hard-code paths if we can avoid it.

    0

  9. Aniket 4 weeks ago

    Very good blog and helpful. Similarly how can we select folder path instead of file?? 

    Thanks in Advance 🙂

     

    0

  10. You just need to use the correct .Net class..

    The documentation is at https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.folderbrowserdialog?view=netframework-4.8. 

    David F. 

    0

  11. Aniket Sonkusare 4 weeks ago

    Thanks David... 🙂

    I have used above code and it is working and I am able to select folder.

    Facing one strange thing. Whenever I work in ISE, the select folder dialogue box went to last open item in windows instead of popping up on current window. But if I use powershell command line, dialogue box popping up and I can select folder.

    0

  12. It'll be a function of where you call the dialog from.  Some apps (like the ISE) will remember the last folder you used, so, unless you specify a root every time, it will go to your last place.  

    Glad it worked out for you though 🙂  

    David F. 

    0

  13. BETOMBO Mariot 2 weeks ago

    Very Usefull. Thanks

    0

Leave a reply

Your email address will not be published. Required fields are marked *

*

© 4sysops 2006 - 2020

CONTACT US

Please ask IT administration questions in the forums. Any other messages are welcome.

Sending

Log in with your credentials

or    

Forgot your details?

Create Account