This topic has not yet been rated - Rate this topic

SaveFileDialog Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.CommonDialog
        System.Windows.Forms.FileDialog
          System.Windows.Forms.SaveFileDialog

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.

  Name Description
Public method SaveFileDialog Initializes a new instance of this class.
Top
  Name Description
Public property 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.)
Public property 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.)
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property 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. (Inherited from FileDialog.)
Public property 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.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Public property CreatePrompt Gets 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 property CustomPlaces Gets the custom places collection for this FileDialog instance. (Inherited from FileDialog.)
Public property DefaultExt Gets or sets the default file name extension. (Inherited from FileDialog.)
Public property 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.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property FileName Gets or sets a string containing the file name selected in the file dialog box. (Inherited from FileDialog.)
Public property FileNames Gets the file names of all selected files in the dialog box. (Inherited from FileDialog.)
Public property 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.)
Public property FilterIndex Gets or sets the index of the filter currently selected in the file dialog box. (Inherited from FileDialog.)
Public property InitialDirectory Gets or sets the initial directory displayed by the file dialog box. (Inherited from FileDialog.)
Protected property Instance Infrastructure. Gets the Win32 instance handle for the application. (Inherited from FileDialog.)
Protected property Options Infrastructure. Gets values to initialize the FileDialog. (Inherited from FileDialog.)
Public property OverwritePrompt Gets 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 property RestoreDirectory Gets or sets a value indicating whether the dialog box restores the current directory before closing. (Inherited from FileDialog.)
Public property ShowHelp Gets or sets a value indicating whether the Help button is displayed in the file dialog box. (Inherited from FileDialog.)
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property SupportMultiDottedExtensions Gets or sets whether the dialog box supports displaying and saving files that have multiple file name extensions. (Inherited from FileDialog.)
Public property Tag Gets or sets an object that contains data about the control. (Inherited from CommonDialog.)
Public property Title Gets or sets the file dialog box title. (Inherited from FileDialog.)
Public property ValidateNames Gets or sets a value indicating whether the dialog box accepts only valid Win32 file names. (Inherited from FileDialog.)
Top
  Name Description
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method HookProc Defines the common dialog box hook procedure that is overridden to add specific functionality to the file dialog box. (Inherited from FileDialog.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OnFileOk Raises the FileOk event. (Inherited from FileDialog.)
Protected method OnHelpRequest Raises the HelpRequest event. (Inherited from CommonDialog.)
Public method OpenFile Opens the file with read/write permission selected by the user.
Protected method OwnerWndProc Defines the owner window procedure that is overridden to add specific functionality to a common dialog box. (Inherited from CommonDialog.)
Public method Reset Resets all dialog box options to their default values. (Overrides FileDialog.Reset().)
Protected method RunDialog Infrastructure. Specifies a common dialog box. (Inherited from FileDialog.)
Public method ShowDialog() Runs a common dialog box with a default owner. (Inherited from CommonDialog.)
Public method ShowDialog(IWin32Window) Runs a common dialog box with the specified owner. (Inherited from CommonDialog.)
Public method ToString Infrastructure. Provides a string version of this object. (Inherited from FileDialog.)
Top
  Name Description
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public event FileOk Occurs when the user clicks on the Open or Save button on a file dialog box. (Inherited from FileDialog.)
Public event HelpRequest Occurs 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, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, 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.
Did you find this helpful?
(1500 characters remaining)