OpenFileDialog Class

Definition

Represents a common dialog box that allows a user to specify a filename for one or more files to open.

public sealed class OpenFileDialog : Microsoft.Win32.FileDialog
Inheritance

Examples

The following example shows how to create an OpenFileDialog that contains a default file name and extension type.

// Configure open file dialog box
Microsoft.Win32.OpenFileDialog dlg = new Microsoft.Win32.OpenFileDialog();
dlg.FileName = "Document"; // Default file name
dlg.DefaultExt = ".txt"; // Default file extension
dlg.Filter = "Text documents (.txt)|*.txt"; // Filter files by extension

// Show open file dialog box
Nullable<bool> result = dlg.ShowDialog();

// Process open file dialog box results
if (result == true)
{
    // Open document
    string filename = dlg.FileName;
}
' Configure open file dialog box
Dim dlg As New Microsoft.Win32.OpenFileDialog()
dlg.FileName = "Document" ' Default file name
dlg.DefaultExt = ".txt" ' Default file extension
dlg.Filter = "Text documents (.txt)|*.txt" ' Filter files by extension

' Show open file dialog box
Dim result? As Boolean = dlg.ShowDialog()

' Process open file dialog box results
If result = True Then
    ' Open document
    Dim filename As String = dlg.FileName
End If

Remarks

The following figure shows an OpenFileDialog for Windows Vista.

Open dialog box

Starting in Windows Vista, open and save file dialog boxes have a Favorite Links panel on the left side of the dialog box that allows the user to quickly navigate to a different location. These links are called custom places. Use the CustomPlaces property to set this list of links.

XAML Text Usage

You cannot declare this managed class in XAML.

Constructors

OpenFileDialog()

Initializes a new instance of the OpenFileDialog class.

Properties

AddExtension

Gets or sets a value indicating whether a file dialog automatically adds an extension to a file name if the user omits an extension.

(Inherited from FileDialog)
CheckFileExists

Gets or sets a value indicating whether a file dialog displays a warning if the user specifies a file name that does not exist.

(Inherited from FileDialog)
CheckPathExists

Gets or sets a value that specifies whether warnings are displayed if the user types invalid paths and file names.

(Inherited from FileDialog)
CustomPlaces

Gets or sets the list of custom places for file dialog boxes.

(Inherited from FileDialog)
DefaultExt

Gets or sets a value that specifies the default extension string to use to filter the list of files that are displayed.

(Inherited from FileDialog)
DereferenceLinks

Gets or sets a value indicating whether a file dialog returns either the location of the file referenced by a shortcut or the location of the shortcut file (.lnk).

(Inherited from FileDialog)
FileName

Gets or sets a string containing the full path of the file selected in a file dialog.

(Inherited from FileDialog)
FileNames

Gets an array that contains one file name for each selected file.

(Inherited from FileDialog)
Filter

Gets or sets the filter string that determines what types of files are displayed from either the OpenFileDialog or SaveFileDialog.

(Inherited from FileDialog)
FilterIndex

Gets or sets the index of the filter currently selected in a file dialog.

(Inherited from FileDialog)
InitialDirectory

Gets or sets the initial directory that is displayed by a file dialog.

(Inherited from FileDialog)
Multiselect

Gets or sets an option indicating whether OpenFileDialog allows users to select multiple files.

Options

Gets the Win32 common file dialog flags that are used by file dialogs for initialization.

(Inherited from FileDialog)
ReadOnlyChecked

Gets or sets a value indicating whether the read-only check box displayed by OpenFileDialog is selected.

RestoreDirectory

This property is not implemented.

(Inherited from FileDialog)
SafeFileName

Gets a string that only contains the file name for the selected file.

(Inherited from FileDialog)
SafeFileNames

Gets an array that contains one safe file name for each selected file.

(Inherited from FileDialog)
ShowReadOnly

Gets or sets a value indicating whether OpenFileDialog contains a read-only check box.

Tag

Gets or sets an object associated with the dialog. This provides the ability to attach an arbitrary object to the dialog.

(Inherited from CommonDialog)
Title

Gets or sets the text that appears in the title bar of a file dialog.

(Inherited from FileDialog)
ValidateNames

Gets or sets a value indicating whether the dialog accepts only valid Win32 file names.

(Inherited from FileDialog)

Methods

CheckPermissionsToShowDialog()

Determines whether sufficient permissions for displaying a dialog exist.

(Inherited from CommonDialog)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
HookProc(IntPtr, Int32, IntPtr, IntPtr)

Defines the common file dialog hook procedure that is overridden to add common functionality to a file dialog.

(Inherited from FileDialog)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnFileOk(CancelEventArgs)

Raises the FileOk event.

(Inherited from FileDialog)
OpenFile()

Opens a read-only stream for the file that is selected by the user using OpenFileDialog.

OpenFiles()

Creates an array that contains one read-only stream for each file selected by the user using OpenFileDialog.

Reset()

Resets all OpenFileDialog properties to their default values.

RunDialog(IntPtr)

RunDialog(IntPtr) is called to display a file dialog in a derived class, such as OpenFileDialog and SaveFileDialog.

(Inherited from FileDialog)
ShowDialog()

Displays a common dialog.

(Inherited from CommonDialog)
ShowDialog(Window)

Displays a common dialog.

(Inherited from CommonDialog)
ToString()

Returns a string that represents a file dialog.

(Inherited from FileDialog)

Events

FileOk

Occurs when the user selects a file name by either clicking the Open button of the OpenFileDialog or the Save button of the SaveFileDialog.

(Inherited from FileDialog)

Applies to