New to Telerik UI for .NET MAUIStart a free 30-day trial

Represents a class for controlling the save to image operation when calling SaveImageAsync(Stream, SaveImageSettings) method. It includes properties for manipulation of the ImageFormat, ImageQuality, ScaleFactor, BackgroundColor of the saved image, as well as the StrokeColor and StrokeThickness of the signature.

Definition

Namespace:Telerik.Maui.Controls.SignaturePad

Assembly:Telerik.Maui.Controls.dll

Syntax:

C#
public class SaveImageSettings

Inheritance: objectSaveImageSettings

Constructors

Initializes a new instance of the SaveImageSettings class.

C#
public SaveImageSettings()

Properties

Gets or sets the BackgroundColor for the encoded image. If the value is null the BackgroundColor will be used. If the value stays null or Color.Transparent: for PNG encoded image - Color.Transparent will be used. for JPEG encoded image - Color.White will be used.

C#
public Color BackgroundColor { get; set; }

Gets or sets the image format to encode the image to.

C#
public ImageFormat ImageFormat { get; set; }

Gets or sets the quality of the encoded image, when using a lossy compression format: the value of 1 specifies the maximum possible quality, resulting in minimum compression; the value of 0 specifies the minimum possible quality, resulting in maximum compression.

C#
public double ImageQuality { get; set; }

Gets or sets a scale factor, which can be used to reduce the size of the final image: values below 1 downscale the image before saving, thus reducing the final image size; values above 1 upscale the image before saving, thus increasing the final image size.

C#
public double ScaleFactor { get; set; }

Gets or sets the stroke color for the signature in the encoded image. If the value is null the StrokeColor will be used.

C#
public Color StrokeColor { get; set; }

Gets or sets the stroke thickness for the signature in the encoded image. If the value is double.NaN, the StrokeThickness will be used.

C#
public double StrokeThickness { get; set; }