OpenFileDialog
OpenFileDialog
OpenFileDialog
OpenFileDialog
Class
Definition
Displays a standard dialog box that prompts the user to open a file. This class cannot be inherited.
public ref class OpenFileDialog sealed : System::Windows::Forms::FileDialogpublic sealed class OpenFileDialog : System.Windows.Forms.FileDialogtype OpenFileDialog = class
inherit FileDialogPublic NotInheritable Class OpenFileDialog
Inherits FileDialog- Inheritance
-
OpenFileDialogOpenFileDialogOpenFileDialogOpenFileDialog
Examples
The following code example creates an OpenFileDialog, sets several properties to define the file extension filter and dialog behavior, and displays the dialog box using the CommonDialog.ShowDialog method. The example requires a form with a Button placed on it and a reference to the System.IO namespace added to it.
private:
void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
Stream^ myStream;
OpenFileDialog^ openFileDialog1 = gcnew OpenFileDialog;
openFileDialog1->InitialDirectory = "c:\\";
openFileDialog1->Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*";
openFileDialog1->FilterIndex = 2;
openFileDialog1->RestoreDirectory = true;
if ( openFileDialog1->ShowDialog() == System::Windows::Forms::DialogResult::OK )
{
if ( (myStream = openFileDialog1->OpenFile()) != nullptr )
{
// Insert code to read the stream here.
myStream->Close();
}
}
}
private void button1_Click(object sender, System.EventArgs e)
{
string fileName = null;
using (OpenFileDialog openFileDialog1 = new OpenFileDialog())
{
openFileDialog1.InitialDirectory = "c:\\";
openFileDialog1.Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*";
openFileDialog1.FilterIndex = 2;
openFileDialog1.RestoreDirectory = true;
if (openFileDialog1.ShowDialog() == DialogResult.OK)
{
fileName = openFileDialog1.FileName;
}
}
if (fileName != null)
{
//Do something with the file, for example read text from it
string text = File.ReadAllText(fileName);
}
}
Private Sub button1_Click(ByVal sender As Object, ByVal e As System.EventArgs)
Dim myStream As Stream = Nothing
Dim openFileDialog1 As New OpenFileDialog()
openFileDialog1.InitialDirectory = "c:\"
openFileDialog1.Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*"
openFileDialog1.FilterIndex = 2
openFileDialog1.RestoreDirectory = True
If openFileDialog1.ShowDialog() = System.Windows.Forms.DialogResult.OK Then
Try
myStream = openFileDialog1.OpenFile()
If (myStream IsNot Nothing) Then
' Insert code to read the stream here.
End If
Catch Ex As Exception
MessageBox.Show("Cannot read file from disk. Original error: " & Ex.Message)
Finally
' Check this again, since we need to make sure we didn't throw an exception on open.
If (myStream IsNot Nothing) Then
myStream.Close()
End If
End Try
End If
End Sub
Remarks
This class allows you to check whether a file exists and to open it. The ShowReadOnly property determines whether a read-only check box appears in the dialog box. The ReadOnlyChecked property indicates whether the read-only check box is checked.
Most of the core functionality for this class is found in the FileDialog class.
On a right-to-left operating system, setting the containing form's RightToLeft property to RightToLeft.Yes localizes the dialog's File Name, Open, and Cancel buttons. If the property is not set to RightToLeft.Yes, English text is used instead.
If you want to give the user the ability to select a folder instead of a file, use FolderBrowserDialog instead.
Constructors
| OpenFileDialog() OpenFileDialog() OpenFileDialog() OpenFileDialog() |
Initializes an instance of the OpenFileDialog class. |
Properties
| AddExtension AddExtension AddExtension AddExtension |
Gets or sets a value indicating whether the dialog box automatically adds an extension to a file name if the user omits the extension. (Inherited from FileDialog) |
| AutoUpgradeEnabled AutoUpgradeEnabled AutoUpgradeEnabled AutoUpgradeEnabled |
Gets or sets a value indicating whether this FileDialog instance should automatically upgrade appearance and behavior when running on Windows Vista. (Inherited from FileDialog) |
| CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents |
Gets a value indicating whether the component can raise an event. (Inherited from Component) |
| CheckFileExists CheckFileExists CheckFileExists CheckFileExists |
Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist. |
| CheckPathExists CheckPathExists CheckPathExists CheckPathExists |
Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a path that does not exist. (Inherited from FileDialog) |
| Container Container Container Container |
Gets the IContainer that contains the Component. (Inherited from Component) |
| CustomPlaces CustomPlaces CustomPlaces CustomPlaces |
Gets the custom places collection for this FileDialog instance. (Inherited from FileDialog) |
| DefaultExt DefaultExt DefaultExt DefaultExt |
Gets or sets the default file name extension. (Inherited from FileDialog) |
| DereferenceLinks DereferenceLinks DereferenceLinks DereferenceLinks |
Gets or sets a value indicating whether the dialog box returns the location of the file referenced by the shortcut or whether it returns the location of the shortcut (.lnk). (Inherited from FileDialog) |
| DesignMode DesignMode DesignMode DesignMode |
Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| Events Events Events Events |
Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| FileName FileName FileName FileName |
Gets or sets a string containing the file name selected in the file dialog box. (Inherited from FileDialog) |
| FileNames FileNames FileNames FileNames |
Gets the file names of all selected files in the dialog box. (Inherited from FileDialog) |
| Filter Filter Filter Filter |
Gets or sets the current file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box. (Inherited from FileDialog) |
| FilterIndex FilterIndex FilterIndex FilterIndex |
Gets or sets the index of the filter currently selected in the file dialog box. (Inherited from FileDialog) |
| InitialDirectory InitialDirectory InitialDirectory InitialDirectory |
Gets or sets the initial directory displayed by the file dialog box. (Inherited from FileDialog) |
| Instance Instance Instance Instance |
Gets the Win32 instance handle for the application. (Inherited from FileDialog) |
| Multiselect Multiselect Multiselect Multiselect |
Gets or sets a value indicating whether the dialog box allows multiple files to be selected. |
| Options Options Options Options |
Gets values to initialize the FileDialog. (Inherited from FileDialog) |
| ReadOnlyChecked ReadOnlyChecked ReadOnlyChecked ReadOnlyChecked |
Gets or sets a value indicating whether the read-only check box is selected. |
| RestoreDirectory RestoreDirectory RestoreDirectory RestoreDirectory |
Gets or sets a value indicating whether the dialog box restores the directory to the previously selected directory before closing. (Inherited from FileDialog) |
| SafeFileName SafeFileName SafeFileName SafeFileName |
Gets the file name and extension for the file selected in the dialog box. The file name does not include the path. |
| SafeFileNames SafeFileNames SafeFileNames SafeFileNames |
Gets an array of file names and extensions for all the selected files in the dialog box. The file names do not include the path. |
| ShowHelp ShowHelp ShowHelp ShowHelp |
Gets or sets a value indicating whether the Help button is displayed in the file dialog box. (Inherited from FileDialog) |
| ShowReadOnly ShowReadOnly ShowReadOnly ShowReadOnly |
Gets or sets a value indicating whether the dialog box contains a read-only check box. |
| Site Site Site Site |
Gets or sets the ISite of the Component. (Inherited from Component) |
| SupportMultiDottedExtensions SupportMultiDottedExtensions SupportMultiDottedExtensions SupportMultiDottedExtensions |
Gets or sets whether the dialog box supports displaying and saving files that have multiple file name extensions. (Inherited from FileDialog) |
| Tag Tag Tag Tag |
Gets or sets an object that contains data about the control. (Inherited from CommonDialog) |
| Title Title Title Title |
Gets or sets the file dialog box title. (Inherited from FileDialog) |
| ValidateNames ValidateNames ValidateNames ValidateNames |
Gets or sets a value indicating whether the dialog box accepts only valid Win32 file names. (Inherited from FileDialog) |
Methods
Events
| Disposed Disposed Disposed Disposed |
Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component) |
| FileOk FileOk FileOk FileOk |
Occurs when the user clicks on the Open or Save button on a file dialog box. (Inherited from FileDialog) |
| HelpRequest HelpRequest HelpRequest HelpRequest |
Occurs when the user clicks the Help button on a common dialog box. (Inherited from CommonDialog) |