Export (0) Print
Expand All

SaveFileDialog Class

Prompts the user to select a location for saving a file. This class cannot be inherited.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public sealed class SaveFileDialog : FileDialog

The SaveFileDialog type exposes the following members.

  NameDescription
Public methodSaveFileDialogInitializes a new instance of this class.
Top

  NameDescription
Public propertyAddExtensionGets 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.)
Public propertyAutoUpgradeEnabledGets or sets a value indicating whether this FileDialog instance should automatically upgrade appearance and behavior when running on Windows Vista. (Inherited from FileDialog.)
Public propertyCheckFileExistsGets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist. (Inherited from FileDialog.)
Public propertyCheckPathExistsGets 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.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyCreatePromptGets or sets a value indicating whether the dialog box prompts the user for permission to create a file if the user specifies a file that does not exist.
Public propertyCustomPlacesGets the custom places collection for this FileDialog instance. (Inherited from FileDialog.)
Public propertyDefaultExtGets or sets the default file name extension. (Inherited from FileDialog.)
Public propertyDereferenceLinksGets 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.)
Public propertyFileNameGets or sets a string containing the file name selected in the file dialog box. (Inherited from FileDialog.)
Public propertyFileNamesGets the file names of all selected files in the dialog box. (Inherited from FileDialog.)
Public propertyFilterGets 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.)
Public propertyFilterIndexGets or sets the index of the filter currently selected in the file dialog box. (Inherited from FileDialog.)
Public propertyInitialDirectoryGets or sets the initial directory displayed by the file dialog box. (Inherited from FileDialog.)
Public propertyOverwritePromptGets or sets a value indicating whether the Save As dialog box displays a warning if the user specifies a file name that already exists.
Public propertyRestoreDirectoryGets or sets a value indicating whether the dialog box restores the current directory before closing. (Inherited from FileDialog.)
Public propertyShowHelpGets or sets a value indicating whether the Help button is displayed in the file dialog box. (Inherited from FileDialog.)
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertySupportMultiDottedExtensionsGets or sets whether the dialog box supports displaying and saving files that have multiple file name extensions. (Inherited from FileDialog.)
Public propertyTagGets or sets an object that contains data about the control. (Inherited from CommonDialog.)
Public propertyTitleGets or sets the file dialog box title. (Inherited from FileDialog.)
Public propertyValidateNamesGets or sets a value indicating whether the dialog box accepts only valid Win32 file names. (Inherited from FileDialog.)
Top

  NameDescription
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodOpenFileOpens the file with read/write permission selected by the user.
Public methodResetResets all dialog box options to their default values. (Overrides FileDialog.Reset().)
Public methodShowDialog()Runs a common dialog box with a default owner. (Inherited from CommonDialog.)
Public methodShowDialog(IWin32Window)Runs a common dialog box with the specified owner. (Inherited from CommonDialog.)
Public methodToStringInfrastructure. Provides a string version of this object. (Inherited from FileDialog.)
Top

  NameDescription
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public eventFileOkOccurs when the user clicks on the Open or Save button on a file dialog box. (Inherited from FileDialog.)
Public eventHelpRequestOccurs when the user clicks the Help button on a common dialog box. (Inherited from CommonDialog.)
Top

This class can either open and overwrite an existing file or create a new file.

Most of the functionality for this class is found in the FileDialog class.

The following code example illustrates creating a SaveFileDialog, setting members, calling the dialog box using the ShowDialog method, and saving the current file. The example requires a form with a button placed on it.

private void button1_Click(object sender, System.EventArgs e)
 {
     Stream myStream ;
     SaveFileDialog saveFileDialog1 = new SaveFileDialog();

     saveFileDialog1.Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*"  ;
     saveFileDialog1.FilterIndex = 2 ;
     saveFileDialog1.RestoreDirectory = true ;

     if(saveFileDialog1.ShowDialog() == DialogResult.OK)
     {
         if((myStream = saveFileDialog1.OpenFile()) != null)
         {
             // Code to write the stream goes here.
             myStream.Close();
         }
     }
 }

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft