Class PdfViewerSignatureDialogSettings

Represents the settings for the signature dialog in the PDF viewer component.

Inheritance
object
PdfViewerAnnotationSettings
PdfViewerShapeSettings
PdfViewerHandwrittenSignatureSettings
PdfViewerSignatureDialogSettings
Inherited Members
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.dll
Syntax
public class PdfViewerSignatureDialogSettings : PdfViewerHandwrittenSignatureSettings
Remarks

This class handles the configuration of options displayed in the signature dialog, including modes such as drawing a signature.

Constructors

PdfViewerSignatureDialogSettings()

Declaration
public PdfViewerSignatureDialogSettings()

Properties

DisplayMode

Get or set the required signature options will be enabled in the signature dialog.

Declaration
[Parameter]
[JsonPropertyName("displayMode")]
public DisplayMode DisplayMode { get; set; }
Property Value
Type
DisplayMode

HideSaveSignature

Hide the save signature checkbox in the signature dialog box.

Declaration
[Parameter]
[JsonPropertyName("hideSaveSignature")]
public bool HideSaveSignature { get; set; }
Property Value
Type
bool

JsNamespace

Gets or sets the JavaScript interop namespace for this component.

Declaration
protected override string JsNamespace { get; set; }
Property Value
Type
string
Overrides

JsProperty

Gets or sets the JS interop property name used internally.

Declaration
protected override string JsProperty { get; set; }
Property Value
Type
string
Overrides

MainParent

Gets or sets the parent base component reference.

Declaration
protected override SfBaseComponent MainParent { get; set; }
Property Value
Type
SfBaseComponent
Overrides

SfTagIndex

Gets or sets tag index used to compose the JS namespace within the parent hierarchy.

Declaration
protected override int SfTagIndex { get; set; }
Property Value
Type
int
Overrides

SignatureFonts

Gets or sets the array of font families that will be available in the signature dialog's "Type" tab for signature fields.

Declaration
[Parameter]
[JsonPropertyName("SignatureFonts")]
public string[] SignatureFonts { get; set; }
Property Value
Type
string[]
Remarks

Defines the style of the text displayed inside the Signature field.
This property is applicable to type tab of the signature field in the signature dialog. It does not affect the "Draw" or "Upload" options of Signature field. If more than four fonts are provided, only the first four fonts in the array will be displayed in the dialog.

The example demonstrates how to apply a custom set of fonts for the signature typing experience in the dialog.

Examples
@using Syncfusion.Blazor.SfPdfViewer 

<SfPdfViewer2 DocumentPath="@DocumentPath" Height="800px" Width="100%"> 
    <PdfViewerSignatureDialogSettings SignatureFonts  = "signatureFonts" >
    </PdfViewerSignatureDialogSettings> 
</SfPdfViewer2> 

@code { 
    private string DocumentPath { get; set; } = "wwwroot/data/sample.pdf"; 
    public string[] signatureFonts =  
    { 
         "Arial", 
         "Courier New", 
         "Georgia", 
         "Times New Roman" 
    }; 
}

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Performs asynchronous initialization for the component, registers it with the parent, and initializes backing fields.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A task that represents the asynchronous initialization operation.
Overrides

OnParametersSetAsync()

Applies parameter changes and updates child properties when needed. Synchronizes backing fields and notifies property changes.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A task that represents the asynchronous parameter-set operation.
Overrides