Getting Started with .NET MAUI SignaturePad

23 Apr 20247 minutes to read

This section explains the steps required to add the SignaturePad control and its elements such as minimum and maximum stroke thickness, and stroke color. This section also covers how to save the signature as an image, clear the existing signature in SignaturePad and handle the DrawStarted and DrawCompleted callbacks in the SignaturePad control.

To get start quickly with our .NET MAUI SignaturePad, you can check the below video.

Creating an application with .NET MAUI

Create a new .NET MAUI application in Visual Studio.

Adding SfSignaturePad reference

The Syncfusion .NET MAUI components are available on nuget.org. To add the SfSignaturePad to your project, open the NuGet package manager in the Visual Studio, search for the Syncfusion.Maui.SignaturePad, and install it.

Handler registration

In the MauiProgram.cs file, register the handler for Syncfusion Core.

C#

using Syncfusion.Maui.Core.Hosting;

namespace SignaturePadGettingStarted
{
    public static class MauiProgram
    {
        public static MauiApp CreateMauiApp()
        {
            var builder = MauiApp.CreateBuilder();
            builder
            .UseMauiApp<App>()
            .ConfigureSyncfusionCore()
            .ConfigureFonts(fonts =>
            {
                fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
            });

            return builder.Build();
        }
    }
}

Initialize signature pad

Import the SfSignaturePad namespace and initialize the SignaturePad as shown below.

XAML

<ContentPage
    . . .
    xmlns:signaturePad="clr-namespace:Syncfusion.Maui.SignaturePad;assembly=Syncfusion.Maui.SignaturePad">
    <Grid>
        <signaturePad:SfSignaturePad />
    </Grid>
</ContentPage>

C#

using Syncfusion.Maui.SignaturePad;

namespace SignaturePadGettingStarted
{
    public partial class MainPage : ContentPage
    {
        public MainPage()
        {
            InitializeComponent();
            // Creating a SignaturePad control.
            SfSignaturePad signaturePad = new SfSignaturePad();
            this.content = signaturePad;
        }
    }
}

Customize signature stroke color

Customize the stroke color of the SignaturePad control by using the StrokeColor property. The default stroke color is Colors.Black.

XAML

<signaturePad:SfSignaturePad StrokeColor="Red" />

C#

SfSignaturePad signaturePad = new SfSignaturePad()
{
    StrokeColor = Colors.Red,
};

Customize signature stroke thickness

The thickness of the stroke drawn can be customized by setting the MinimumStrokeThickness and MaximumStrokeThickness properties. The MinimumStrokeThickness defines the minimum thickness of the stroke and the MaximumStrokeThickness defines the maximum thickness of the stroke that can be drawn based on the speed and impression we provide through gesture within its minimum and maximum stroke thickness ranges. So that the signature will be more realistic.

XAML

<signaturePad:SfSignaturePad MinimumStrokeThickness="1"
                             MaximumStrokeThickness="6" />

C#

SfSignaturePad signaturePad = new SfSignaturePad()
{
    MinimumStrokeThickness = 1,
    MaximumStrokeThickness = 6,
};

Saving the signature as an image

Save the signature drawn in the SignaturePad as an ImageSource using the ToImageSource() method which can further be synchronized with your devices and documents that need your signature.

XAML

<signaturePad:SfSignaturePad x:Name="signaturePad" />
<Button Text="Save"
        Clicked="OnSaveButtonClicked" />

C#

SfSignaturePad signaturePad = new SfSignaturePad();
Button saveButton = new Button();
saveButton.Clicked += OnSaveButtonClicked;

private void OnSaveButtonClicked(object? sender, EventArgs e)
{
    ImageSource? source = signaturePad.ToImageSource();
}

Clear the existing signature in SignaturePad

Clear the signature drawn in the SignaturePad using the Clear() method as shown in the code snippet below:

XAML

<signaturePad:SfSignaturePad x:Name="signaturePad" />
<Button Text="Clear"
        Clicked="OnClearButtonClicked" />

C#

SfSignaturePad signaturePad = new SfSignaturePad();
Button clearButton = new Button();
clearButton.Clicked += OnClearButtonClicked;

private void OnClearButtonClicked(object? sender, EventArgs e)
{
    ImageSource? source = signaturePad.Clear();
}

Events

DrawStarted

This event will be triggered when we start drawing in the SignaturePad. With this, CancelEventArgs will be passed. Also, restrict the draw start action by setting e.cancel as true.

XAML

<signaturePad:SfSignaturePad DrawStarted="OnDrawStarted" />

C#

SfSignaturePad signaturePad = new SfSignaturePad()
{ 
    DrawStarted += OnDrawStarted
};
private void OnDrawStarted(object? sender, CancelEventArgs e)
{
    e.Cancel = false;
}

DrawCompleted

This event will be triggered when we complete the drawing in the SignaturePad.

XAML

<signaturePad:SfSignaturePad DrawCompleted="OnDrawCompleted" />

C#

SfSignaturePad signaturePad = new SfSignaturePad()
{
    DrawCompleted += OnDrawCompleted
};
private void OnDrawCompleted(object? sender, EventArgs e)
{
}

NOTE

You can refer to our .NET MAUI SignaturePad feature tour page for its groundbreaking feature representations. You can also explore our .NET MAUI SignaturePad Example that shows you how to render the SignaturePad in .NET MAUI.