DigitalSignatureSettings Class

Provides settings that control digital signing, signature validation, and signature-related user interface behavior in the PDF Viewer.

Inheritance

System.Object

DigitalSignatureSettings

Namespace: Syncfusion.Maui.PdfViewer

Assembly: Syncfusion.Maui.PdfViewer.dll

Syntax

public sealed class DigitalSignatureSettings : Object

Remarks

Configure signing, validation, signature panel behavior, and custom signing-provider integration for digital signature workflows.

Properties

EnableSigning

Gets or sets a value indicating whether users can digitally sign signature fields in the loaded PDF document.

Declaration

public bool EnableSigning { get; set; }

Property Value

Type
System.Boolean

Remarks

Enable this property to allow users to sign unsigned signature fields within the document.

Examples

pdfViewer.DigitalSignatureSettings.EnableSigning = true;

EnableValidation

Gets or sets a value indicating whether digital signature validation is enabled.

Declaration

public bool EnableValidation { get; set; }

Property Value

Type
System.Boolean

Remarks

When enabled, signatures are validated automatically during document load, after signing operations, and when validation is explicitly requested using SfPdfViewer.ValidateSignaturesAsync().

Examples

pdfViewer.DigitalSignatureSettings.EnableValidation = true;

IsSignaturePanelVisible

Gets or sets a value indicating whether the signature panel is displayed in the PDF Viewer.

Declaration

public bool IsSignaturePanelVisible { get; set; }

Property Value

Type
System.Boolean

Remarks

The signature panel displays signed and unsigned signature fields available in the document. Set this property to true to open the signature panel and to false to close it. The property is two-way synchronized with the internal SfPdfViewer.IsSignaturePanelVisible BindableProperty, so toggling this value (or the toolbar button) keeps both states aligned. If the value is true when a PDF is loaded, the signature panel is opened automatically.

Examples

pdfViewer.DigitalSignatureSettings.IsSignaturePanelVisible = true;

IsValidationBannerVisible

Gets or sets a value indicating whether the digital signature validation banner is displayed.

Declaration

public bool IsValidationBannerVisible { get; set; }

Property Value

Type
System.Boolean

Remarks

The validation banner displays the validation status of digital signatures in the loaded document.

Examples

pdfViewer.DigitalSignatureSettings.IsValidationBannerVisible = true;

SignatureFieldTapAction

Gets or sets the action performed when a user taps an unsigned signature field.

Declaration

public SignatureFieldTapAction SignatureFieldTapAction { get; set; }

Property Value

Type
SignatureFieldTapAction

Remarks

Use this property to customize the interaction behavior for unsigned signature fields.

SignaturePanelSettings

Gets the settings used to configure the digital signature panel.

Declaration

public SignaturePanelSettings SignaturePanelSettings { get; }

Property Value

Type
SignaturePanelSettings

Remarks

Use this property to customize the visibility and behavior of items displayed in the signature panel.

SigningProvider

Gets or sets the host-supplied signing provider.

Declaration

public ISignatureProvider SigningProvider { get; set; }

Property Value

Type
ISignatureProvider

Remarks

Use this property to integrate cloud signing services, HSM devices, enterprise PKI infrastructure, or custom signing solutions.

TrustedCertificates

Gets the collection of root and intermediate certificates used to establish trust during digital signature validation.

Declaration

public IList<X509Certificate2> TrustedCertificates { get; }

Property Value

Type
System.Collections.Generic.IList<System.Security.Cryptography.X509Certificates.X509Certificate2>

Remarks

Certificates added to this collection participate in building and validating certificate trust chains.