Documentation

Class RadSignaturePad

Provides support for drawing and saving signatures.

Inheritance
System.Object
RadContentView
RadBorder
RadSignaturePad
Inherited Members
Namespace: Telerik.Maui.Controls
Assembly: Telerik.Maui.Controls.dll

Syntax

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

Constructors

RadSignaturePad()

Initializes a new instance of the RadSignaturePad class.

Declaration
public RadSignaturePad()

Fields

ActualStyleProperty

Identifies the ActualStyle property.

Declaration
public static readonly BindableProperty ActualStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

BackgroundColorProperty

Identifies the BackgroundColor property.

Declaration
public static readonly BindableProperty BackgroundColorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

StrokeColorProperty

Identifies the StrokeColor property.

Declaration
public static readonly BindableProperty StrokeColorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

StrokeThicknessProperty

Identifies the StrokeThickness property.

Declaration
public static readonly BindableProperty StrokeThicknessProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

StyleProperty

Identifies the Style property.

Declaration
public static readonly BindableProperty StyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

Properties

ActualStyle

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

Declaration
public Style ActualStyle { get; }
Property Value
Microsoft.Maui.Controls.Style

BackgroundColor

Declaration
public Color BackgroundColor { get; set; }
Property Value
Microsoft.Maui.Graphics.Color

ClearCommand

Gets a command to clear the RadSignaturePad.

Declaration
public ICommand ClearCommand { get; }
Property Value
System.Windows.Input.ICommand

StrokeColor

Gets or sets the stroke color for the signature.

Declaration
public Color StrokeColor { get; set; }
Property Value
Microsoft.Maui.Graphics.Color

StrokeThickness

Gets or sets the stroke thickness for the signature.

Declaration
public double StrokeThickness { get; set; }
Property Value
System.Double

Style

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

Declaration
public Style Style { get; set; }
Property Value
Microsoft.Maui.Controls.Style

Methods

SaveImageAsync(Stream)

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

Declaration
public Task SaveImageAsync(Stream outputStream)
Parameters
System.IO.Stream outputStream

Specifies the output stream to save the image to.
Returns
System.Threading.Tasks.Task

Returns a System.Threading.Tasks.Task to await the asynchronous operation.
Exceptions
System.ArgumentNullException

The image buffer data is null.
System.ArgumentOutOfRangeException

The image buffer data count is negative number.
System.IO.IOException

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

The outputStream does not support writing.
System.ObjectDisposedException

Writing to outputStream is called after the stream was closed.

SaveImageAsync(Stream, SaveImageSettings)

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

Declaration
public Task SaveImageAsync(Stream outputStream, SaveImageSettings settings)
Parameters
System.IO.Stream outputStream

Specifies the output stream to save the image to.
SaveImageSettings settings

Specifies the SaveImageSettings to be used for encoding the image.
Returns
System.Threading.Tasks.Task

Returns a System.Threading.Tasks.Task to await the asynchronous operation.
Exceptions
System.ArgumentNullException

The image buffer data is null.
System.ArgumentOutOfRangeException

The image buffer data count is negative number.
System.IO.IOException

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

The outputStream does not support writing.
System.ObjectDisposedException

Writing to outputStream is called after the stream was closed.
System.Exception

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

Events

Cleared

Raised when the surface of RadSignaturePad is cleared.

Declaration
public event EventHandler Cleared
Event Type
System.EventHandler

StrokeCompleted

Raised when a new stroke is completed in RadSignaturePad.

Declaration
public event EventHandler StrokeCompleted
Event Type
System.EventHandler

StrokeStarted

Raised when a new stroke is started in RadSignaturePad.

Declaration
public event EventHandler StrokeStarted
Event Type
System.EventHandler

Extension Methods