Edit

Share via

FolderPicker

  • Article

The FolderPicker provides the ability to pick a folder from the file system.

The following preconditions required for the FolderPicker:

Add permissions to AndroidManifest.xml:

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

Syntax

C#

The FolderPicker can be used as follows in C#:

async Task PickFolder(CancellationToken cancellationToken)
{
    var result = await FolderPicker.Default.PickAsync(cancellationToken);
    if (result.IsSuccessful)
    {
        await Toast.Make($"The folder was picked: Name - {result.Folder.Name}, Path - {result.Folder.Path}", ToastDuration.Long).Show(cancellationToken);
    }
    else
    {
        await Toast.Make($"The folder was not picked with error: {result.Exception.Message}").Show(cancellationToken);
    }
}

Folder

The Folder record represents a folder in the file system. It defines the following properties:

  • Path contains a Folder path.
  • Name contains a Folder name.

FolderPickerResult

Stores information from PickAsync.

Properties

Property Type Description
Folder Folder Gets the Folder that represents the selected folder in the file system.
Exception Exception Gets the Exception if the pick operation failed.
IsSuccessful bool Gets a value determining whether the operation was successful.

Methods

Method Description
EnsureSuccess Verifies whether the pick operation was successful.

Warning

EnsureSuccess will throw an Exception if the pick operation was unsuccessful.

Methods

Method Description
PickAsync Asks for permission and allows selecting a folder in the file system.

Dependency Registration

In case you want to inject service, you first need to register it. Update MauiProgram.cs with the next changes:

public static class MauiProgram
{
    public static MauiApp CreateMauiApp()
    {
        var builder = MauiApp.CreateBuilder();
        builder
            .UseMauiApp<App>()
            .UseMauiCommunityToolkit();

        // Register the FolderPicker as a singleton
        builder.Services.AddSingleton<IFolderPicker>(FolderPicker.Default);
        
        // Register the MainPage as transient to make sure it can resolve the IFolderPicker dependency.
        builder.Services.AddTransient<MainPage>();
        return builder.Build();
    }
}

Now you can inject the service like this:

public partial class MainPage : ContentPage
{
    private readonly IFolderPicker folderPicker;

    public MainPage(IFolderPicker folderPicker)
    {
        InitializeComponent();
        this.folderPicker = folderPicker;
    }

    async Task PickFolder(CancellationToken cancellationToken)
    {
        var result = await folderPicker.PickAsync(cancellationToken);
        result.EnsureSuccess();
        await Toast.Make($"Folder picked: Name - {result.Folder.Name}, Path - {result.Folder.Path}", ToastDuration.Long).Show(cancellationToken);
    }
}

For more detail on how to provide a CancellationToken refer to the Microsoft documentation.

Examples

You can find an example of FolderPicker in action in the .NET MAUI Community Toolkit Sample Application.

API

You can find the source code for FolderPicker over on the .NET MAUI Community Toolkit GitHub repository.