New to Telerik UI for .NET MAUI? Start a free 30-day trial

RadSignaturePad

Class

Provides support for drawing and saving signatures.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:

public class RadSignaturePad : RadBorder, IRadBorder, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Inheritance: objectRadContentViewRadBorderRadSignaturePad

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadBorderIRadContentViewITransformIView...

Inherited Members RadBorder.BorderColorPropertyRadBorder.CornerRadiusPropertyRadBorder.BorderThicknessPropertyRadBorder.BorderBrushPropertyRadBorder.ChangeVisualState()RadBorder.BorderColorRadBorder.CornerRadiusRadBorder.BorderThicknessRadBorder.BorderBrushRadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)RadContentView.OnBindingContextChanged()RadContentView.OnHandlerChanged()...

Constructors

RadSignaturePad()

Initializes a new instance of the RadSignaturePad class.

public RadSignaturePad()

Fields

ActualStyleProperty

BindableProperty

Identifies the ActualStyle property.

public static readonly BindableProperty ActualStyleProperty

BackgroundColorProperty

BindableProperty

Identifies the BackgroundColor property.

public static readonly BindableProperty BackgroundColorProperty

StrokeColorProperty

BindableProperty

Identifies the StrokeColor property.

public static readonly BindableProperty StrokeColorProperty

StrokeThicknessProperty

BindableProperty

Identifies the StrokeThickness property.

public static readonly BindableProperty StrokeThicknessProperty

StyleProperty

BindableProperty

Identifies the Style property.

public static readonly BindableProperty StyleProperty

Properties

ActualStyle

Style

Gets the result from merging the Style property with the default Style of the control.

public Style ActualStyle { get; }

BackgroundColor

Color

public Color BackgroundColor { get; set; }

ClearCommand

ICommand

Gets a command to clear the RadSignaturePad.

The following example demonstrates how to use RadSignaturePad in XAML with a Button that clears the signature pad by binding its Command property to ClearCommand.

csharp

<telerik:RadSignaturePad x:Name="signaturePad" />
<Button Text="Clear" Command="{Binding Source={x:Reference signaturePad}, Path=ClearCommand}" />

public ICommand ClearCommand { get; }

StrokeColor

Color

Gets or sets the stroke color for the signature.

public Color StrokeColor { get; set; }

StrokeThickness

double

Gets or sets the stroke thickness for the signature.

public double StrokeThickness { get; set; }

Style

Gets or sets a Style to be applied to the RadSignaturePad.

public Style Style { get; set; }

Methods

SaveImageAsync(Stream, SaveImageSettings)

Saves drawn signature to the specified stream, encoding it using the provided SaveImageSettings.

public Task SaveImageAsync(Stream outputStream, SaveImageSettings settings)

Parameters:outputStreamStream

Specifies the output stream to save the image to.

settingsSaveImageSettings

Specifies the SaveImageSettings to be used for encoding the image.

Returns:

Task

Returns a Task to await the asynchronous operation.

Exceptions: ArgumentNullException

The image buffer data is null.

ArgumentOutOfRangeException

The image buffer data count is negative number.

IOException

An I/O error occured, such as the specified file cannot be found.

NotSupportedException

The outputStream does not support writing.

ObjectDisposedException

Writing to outputStream is called after the stream was closed.

Exception

Unable to allocate pixels for the bitmap. Can occur with big values for ScaleFactor.

SaveImageAsync(Stream)

Saves drawn signature to the specified stream, encoding it as Png, using the RadSignaturePad's , StrokeColor and StrokeThickness.

public Task SaveImageAsync(Stream outputStream)

Parameters:outputStreamStream

Specifies the output stream to save the image to.

Returns:

Task

Returns a Task to await the asynchronous operation.

Exceptions: ArgumentNullException

The image buffer data is null.

ArgumentOutOfRangeException

The image buffer data count is negative number.

IOException

An I/O error occured, such as the specified file cannot be found.

NotSupportedException

The outputStream does not support writing.

ObjectDisposedException

Writing to outputStream is called after the stream was closed.

Events

Cleared

EventHandler

Raised when the surface of RadSignaturePad is cleared.

public event EventHandler Cleared

StrokeCompleted

EventHandler

Raised when a new stroke is completed in RadSignaturePad.

public event EventHandler StrokeCompleted

StrokeStarted

EventHandler

Raised when a new stroke is started in RadSignaturePad.

public event EventHandler StrokeStarted