Class FormFieldAddEventArgs

Provides event data for the form field addition event in the SfPdfViewer2 component.

Inheritance
System.Object
FormFieldAddedEventArgs
FormFieldAddEventArgs
Inherited Members
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.dll
Syntax
public class FormFieldAddEventArgs : FormFieldAddedEventArgs
Remarks

This class inherits from FormFieldAddedEventArgs and includes additional
details specific to when a form field is about to be adding form field. It is used to handle events triggered when a user starts adding a new form field.

Examples

The following example demonstrates how to handle the FormFieldAdding event.

<SfPdfViewer2 @ref="Viewer" Height="100%" Width="100%">
    <PdfViewerEvents FormFieldAdding="@OnFormFieldAdding"></PdfViewerEvents>
</SfPdfViewer2>

@code {
SfPdfViewer2 Viewer;
void OnFormFieldAdding(FormFieldAddEventArgs args)
{
    // Access details about the form field being added
    Console.WriteLine($"Form field being added: {args.Field.Name}");
    // Additional processing logic
}
}

Constructors

FormFieldAddEventArgs()

Declaration
public FormFieldAddEventArgs()

Properties

Cancel

Gets or sets a value indicating whether the addition of a form field should be canceled in the SfPdfViewer2 component.
The default value is false.

Declaration
public bool Cancel { get; set; }
Property Value
Type Description
System.Boolean

A System.Boolean indicating whether the form field addition should be canceled.
A value of true prevents the addition, while false allows it.
Remarks

When set to true, the form field addition will be prevented.
Use this property to enforce custom validation or business rules before allowing a form field to be added.

Examples

The following example demonstrates how to cancel the form field addition based on a condition.

<SfPdfViewer2 @ref="Viewer" Height="100%" Width="100%">
    <PdfViewerEvents FormFieldAdding="@OnFormFieldAdding"></PdfViewerEvents>
</SfPdfViewer2>

@code {
SfPdfViewer2 Viewer;
void OnFormFieldAdding(FormFieldAddEventArgs args)
{
    if (args.Field.Name == "RestrictedField")
    {
        args.Cancel = true; // Prevent the form field from being added
    }
}
}