FolderBrowserDialog详解

发布时间:2023-05-21

一、基本概念

FolderBrowserDialog是Windows Forms 目录对话框的类。它允许用户选择文件夹并返回选中文件夹的路径。 用户操作后,将使用改选文件夹的路径来更新FolderBrowserDialog.SelectedPath 属性 。如果FolderBrowserDialog.ShowDialog 方法的返回值为OK ,则将使用SelectedPath的值执行特定的操作。

二、使用方法

要使用FolderBrowserDialog,需要以下步骤: 1、创建FolderBrowserDialog的实例:

FolderBrowserDialog folderBrowserDialog1 = new FolderBrowserDialog(); 

2、使用该实例的属性设置FolderBrowserDialog:

folderBrowserDialog1.Description = "Select a folder:"; 

可以设置Title属性为需要展示的对话框的标题,例如"Folder Browser Dialog"。 3、调用ShowDialog方法:

if (folderBrowserDialog1.ShowDialog() == DialogResult.OK) { 
    //返回选择的路径 
    string path = folderBrowserDialog1.SelectedPath; 
} 

在ShowDialog()方法返回之前,用户始终可以更改选择的项。如果用户单击“取消”按钮,则ShowDialog()方法将返回“Cancel”结果。

三、常见功能

1、设置起始路径

可以设置FolderBrowserDialog.SelectedPath属性指定启动时要显示的文件夹路径。例如:

folderBrowserDialog1.SelectedPath = @"C:\Users"; 

2、禁止创建新文件夹

要禁用用户创建新文件夹的选项,请将FolderBrowserDialog.ShowNewFolderButton属性设置为false:

folderBrowserDialog1.ShowNewFolderButton = false; 

3、过滤文件夹

可以使用FolderBrowserDialog.RootFolder属性指定要从中开始浏览文件夹的位置。 可以使用FolderBrowserDialog.RootFolder属性过滤FolderBrowserDialog可选择的文件夹。例如,如果只允许用户选择桌面上的文件夹,则可以将该属性设置为SpecialFolder.Desktop。 示例代码:

folderBrowserDialog1.RootFolder = Environment.SpecialFolder.Desktop; 

4、指定根节点

可以使用FolderBrowserDialog.RootFolder属性指定要从中开始浏览文件夹的位置。 可用根路径值有:

  • Desktop
  • MyDocuments
  • MyComputer
  • Personal 示例代码:
folderBrowserDialog1.RootFolder = Environment.SpecialFolder.Desktop; 

5、自定义按钮文本

可以使用FolderBrowserDialog的UseDescriptionForTitle属性,将FolderBrowserDialog.Description属性中的文本用作控件的标题。 示例代码:

folderBrowserDialog1.Description = "Custom button text:";
folderBrowserDialog1.UseDescriptionForTitle = true;

四、完整示例代码

using System;
using System.ComponentModel;
using System.Windows.Forms;
public class Form1 : Form
{
    private Button button1;
    private FolderBrowserDialog folderBrowserDialog1;
    private void InitializeComponent()
    {
        this.button1 = new System.Windows.Forms.Button();
        this.folderBrowserDialog1 = new System.Windows.Forms.FolderBrowserDialog();
        this.SuspendLayout();
        this.button1.Location = new System.Drawing.Point(75, 72);
        this.button1.Name = "button1";
        this.button1.TabIndex = 0;
        this.button1.Text = "Open folder";
        this.button1.UseVisualStyleBackColor = true;
        this.button1.Click += new System.EventHandler(this.button1_Click);
        this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
        this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
        this.ClientSize = new System.Drawing.Size(284, 262);
        this.Controls.Add(this.button1);
        this.Name = "Form1";
        this.Text = "FolderBrowserDialog";
        this.ResumeLayout(false);
    }
    private void button1_Click(object sender, EventArgs e)
    {
        folderBrowserDialog1.Description = "Browse for folder";
        folderBrowserDialog1.ShowNewFolderButton = false;
        folderBrowserDialog1.RootFolder = Environment.SpecialFolder.MyComputer;
        if (folderBrowserDialog1.ShowDialog() == DialogResult.OK)
        {
            string folderPath = folderBrowserDialog1.SelectedPath;
            MessageBox.Show(folderPath, "Selected Folder Path");
        }
    }
    static void Main()
    {
        Application.EnableVisualStyles();
        Application.SetCompatibleTextRenderingDefault(false);
        Application.Run(new Form1());
    }
}