WPF SaveFileDialog文件保存对话框的详细使用教程

SaveFileDialog 是 WPF 中用于让用户选择保存文件位置和文件名的对话框，常用于保存文件、导出文件等场景。它和 OpenFileDialog 类似，但专注于保存操作。SaveFileDialog 位于 Microsoft.Win32 命名空间。以下是 SaveFileDialog 的详细使用教程，包括基本用法、设置过滤器、默认文件名、检查路径、以及获取保存的文件路径。

1. 引入命名空间

在使用 SaveFileDialog 之前，需要引入正确的命名空间：

using Microsoft.Win32;

2. 基本使用

最简单的 SaveFileDialog 用法是创建一个实例，并调用其 ShowDialog() 方法。当用户选择了文件名并点击 “保存” 按钮后，可以通过 FileName 属性获取保存路径。

SaveFileDialog saveFileDialog = new SaveFileDialog();
if (saveFileDialog.ShowDialog() == true)
{
    string filePath = saveFileDialog.FileName;
    // 在此处处理保存操作，如写入文件
    MessageBox.Show("File will be saved to: " + filePath);
}

• ShowDialog() 返回一个 bool? 类型，当用户点击 “保存” 按钮时，返回 true；否则返回 false。
• FileName 属性是保存文件的完整路径（包括文件名）。

3. 设置文件类型过滤器

通过 Filter 属性可以限制用户保存的文件类型。Filter 属性的格式为 "描述|文件扩展名"，可以设置多个过滤条件，用竖线（|）分隔。

SaveFileDialog saveFileDialog = new SaveFileDialog();
saveFileDialog.Filter = "Text files (*.txt)|*.txt|All files (*.*)|*.*";
if (saveFileDialog.ShowDialog() == true)
{
    string filePath = saveFileDialog.FileName;
    MessageBox.Show("File will be saved to: " + filePath);
}

在这个例子中，用户可以选择保存为 .txt 文件或任意类型的文件：

• Text files (*.txt)：显示的描述。
• *.txt：实际的文件扩展名过滤器，限制保存文件的格式。
• All files (*.*)：允许用户保存任何文件。

4. 设置默认文件名

FileName 属性不仅可以在文件保存后获取文件路径，还可以在保存之前设置默认文件名。用户可以在对话框中看到这个默认文件名。

SaveFileDialog saveFileDialog = new SaveFileDialog();
saveFileDialog.FileName = "default.txt";  // 默认文件名
saveFileDialog.Filter = "Text files (*.txt)|*.txt|All files (*.*)|*.*";
if (saveFileDialog.ShowDialog() == true)
{
    string filePath = saveFileDialog.FileName;
    MessageBox.Show("File will be saved to: " + filePath);
}

这样，当保存对话框打开时，文件名字段中会预填充为 default.txt。

5. 设置初始目录

通过 InitialDirectory 属性，可以设置对话框打开时默认显示的目录。例如，你可以设置为桌面或某个固定的文件夹路径。

SaveFileDialog saveFileDialog = new SaveFileDialog();
saveFileDialog.InitialDirectory = @"C:\Users\YourUserName\Desktop";  // 初始目录
saveFileDialog.Filter = "Text files (*.txt)|*.txt|All files (*.*)|*.*";
if (saveFileDialog.ShowDialog() == true)
{
    string filePath = saveFileDialog.FileName;
    MessageBox.Show("File will be saved to: " + filePath);
}

用户打开保存对话框时，会自动定位到指定的目录。

6. 添加默认扩展名

DefaultExt 属性用于设置文件的默认扩展名。如果用户在文件名中没有指定扩展名，SaveFileDialog 会自动为文件名加上这个扩展名。

SaveFileDialog saveFileDialog = new SaveFileDialog();
saveFileDialog.Filter = "Text files (*.txt)|*.txt|All files (*.*)|*.*";
saveFileDialog.DefaultExt = "txt";  // 默认扩展名
if (saveFileDialog.ShowDialog() == true)
{
    string filePath = saveFileDialog.FileName;
    MessageBox.Show("File will be saved to: " + filePath);
}

例如，如果用户在文件名中没有输入扩展名，保存时会自动加上 .txt。

7. 检查文件是否存在

可以通过 OverwritePrompt 属性控制在文件已存在时是否提示用户确认是否覆盖文件。SaveFileDialog 默认会提示用户是否覆盖。

SaveFileDialog saveFileDialog = new SaveFileDialog();
saveFileDialog.Filter = "Text files (*.txt)|*.txt|All files (*.*)|*.*";
saveFileDialog.OverwritePrompt = true;  // 提示是否覆盖
if (saveFileDialog.ShowDialog() == true)
{
    string filePath = saveFileDialog.FileName;
    MessageBox.Show("File will be saved to: " + filePath);
}

当 OverwritePrompt 为 true 时，如果用户选择的文件已经存在，系统会弹出提示对话框，询问用户是否覆盖该文件。

8. 检查路径和文件有效性

CheckPathExists 属性用于检查用户选择的路径是否存在；CheckFileExists 通常在保存对话框中不使用，因为保存时文件不一定已经存在。

SaveFileDialog saveFileDialog = new SaveFileDialog();
saveFileDialog.Filter = "All files (*.*)|*.*";
saveFileDialog.CheckPathExists = true;  // 检查路径是否存在
if (saveFileDialog.ShowDialog() == true)
{
    string filePath = saveFileDialog.FileName;
    MessageBox.Show("File will be saved to: " + filePath);
}

设置 CheckPathExists 为 true 后，如果用户输入了一个无效的路径，会弹出错误提示。

9. 完整示例

以下是一个完整的示例，展示了如何使用 SaveFileDialog 来保存文件，设置初始目录、文件过滤器、默认文件名等：

using Microsoft.Win32;
using System.IO;
using System.Windows;

namespace WpfApp
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private void SaveFile_Click(object sender, RoutedEventArgs e)
        {
            SaveFileDialog saveFileDialog = new SaveFileDialog();
            saveFileDialog.InitialDirectory = @"C:\Users\YourUserName\Documents";
            saveFileDialog.Filter = "Text files (*.txt)|*.txt|All files (*.*)|*.*";
            saveFileDialog.FileName = "default.txt";
            saveFileDialog.DefaultExt = "txt";
            saveFileDialog.OverwritePrompt = true;
            saveFileDialog.CheckPathExists = true;

            if (saveFileDialog.ShowDialog() == true)
            {
                string filePath = saveFileDialog.FileName;
                // 在此处执行保存文件的逻辑
                File.WriteAllText(filePath, "Your file content here...");
                MessageBox.Show("File saved successfully to: " + filePath);
            }
        }
    }
}

10. 保存文件的逻辑

在使用 SaveFileDialog 时，通常需要在获取到文件路径后执行保存操作。你可以通过 File.WriteAllText()、FileStream 或其他文件写入方法来保存数据到指定路径。

例如：

string content = "This is the content of the file.";
File.WriteAllText(filePath, content);

总结

SaveFileDialog 是 WPF 中用来保存文件的常用工具，通过设置文件类型过滤器、默认文件名、扩展名等属性，可以使用户体验更加顺畅和友好。该对话框易于使用，并且可以灵活地处理不同的文件保存需求。