SaveFileDialog

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• CommonDialog
  • FileDialog
    • SaveFileDialog

Prompts the user to select a location for saving a file on the server.

C#

public class SaveFileDialog : FileDialog

VB.NET

Public Class SaveFileDialog
    Inherits FileDialog

You can:

• Override PromptFileNotFound. It's called when the specified file doesn't exist and the property CheckFileExists is true.
• Override PromptFileCreate. It's called when the specified file doesn't exist and the property CreatePrompt is true.
• Override PromptFileOverwrite. It's called when the specified file doesn't exist and the property OverwritePrompt is true.
• Override CreateUI to create your custom Form when the method ShowDialog is called.
• Set the DialogTemplate to a Form class that has a constructor that accepts FileDialog as the single argument to change the User Interface (UI) of the file dialog.
• Override OnFileOk to provide your custom implementation of the actions to execute when the user presses the OK button.

You must add at least one IFileSystemProvider to the Roots collection before showing the dialog.

Constructors

SaveFileDialog()

Initializes a new instance of SaveFileDialog.

SaveFileDialog(container)

Initializes a new instance of the SaveFileDialog extender with a specified container.

Name	Type	Description
container	IContainer	An IContainer that represents the container of the SaveFileDialog component.

Properties

CreatePrompt

Boolean: Returns or sets a value indicating whether the dialog box prompts the user for permission to create a file, if the file specified file does not exist. (Default: False)

OverwritePrompt

Boolean: Returns or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that already exists. (Default: True)

Methods

OpenFile()

Opens the file with read/write permission selected by the user.

Returns: Stream. A Stream that specifies the read/write file selected by the user.

Throws:

• ArgumentNullException FileName is empty or null.

ProcessFileNames(fileNames)

Receives the file names selected by the user and validates them according to the properties set in the FileDialog instance.

Parameter	Type	Description
fileNames	String[]	Array containing the selected file paths.

Returns: Boolean. True if the files have been validated and the dialog can close; otherwise false to keep the dialog open.

PromptFileCreate(fileName)

Asks the user's permission to create the specified fileName .

Parameter	Type	Description
fileName	String	File name to create.

Returns: Boolean. True if the user confirms to create the file.

PromptFileOverwrite(fileName)

Asks the user's permission to overwrite the specified fileName .

Parameter	Type	Description
fileName	String	File name to overwrite.

Returns: Boolean. True if the user confirms to overwrite the file.

Reset()

Resets all dialog box options to their default values.