PdfAcroFormFacade.GetSignatureFormField(String) Method

Gets a specific signature form field’s properties.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v25.1.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public PdfSignatureFormFieldFacade GetSignatureFormField(
    string fullName
)

VB.NET

Public Function GetSignatureFormField(
    fullName As String
) As PdfSignatureFormFieldFacade

Parameters

Name	Type	Description
fullName	String	The form field name.

Returns

Type	Description
PdfSignatureFormFieldFacade	An object that contains the form field’s properties.

Remarks

The PdfSignatureFormFieldFacade object contains form field and widget properties without access to the form field’s inner structure. Use the Widgets property to get the form field widget settings.

The code sample below changes the signature field’s widget properties:

C#

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
    pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf");

    PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
    PdfAcroFormFacade acroForm = documentFacade.AcroForm;

    PdfSignatureFormFieldFacade signatureField = acroForm.GetSignatureFormField("Signature");
    signatureField.Required = true;

    PdfSignatureWidgetFacade signatureWidget = signatureField.Widgets[0];
    signatureWidget.BorderWidth = 1;
    signatureWidget.BackgroundColor = new PdfRGBColor(0.81, 0.81, 0.81);
    signatureWidget.BorderColor = new PdfRGBColor(0.47, 0.44, 0.67);
    signatureWidget.FontColor = new PdfRGBColor(0.34, 0.25, 0.36);
    pdfDocumentProcessor.SaveDocument("FormDemo_new.pdf");
}

VB.NET

Using pdfDocumentProcessor As New PdfDocumentProcessor()
  pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf")

  Dim documentFacade As PdfDocumentFacade = pdfDocumentProcessor.DocumentFacade
  Dim acroForm As PdfAcroFormFacade = documentFacade.AcroForm

  Dim signatureField As PdfSignatureFormFieldFacade = acroForm.GetSignatureFormField("Signature")
  signatureField.Required = True

  Dim signatureWidget As PdfSignatureWidgetFacade = signatureField.Widgets(0)
  signatureWidget.BorderWidth = 1
  signatureWidget.BackgroundColor = New PdfRGBColor(0.81, 0.81, 0.81)
  signatureWidget.BorderColor = New PdfRGBColor(0.47, 0.44, 0.67)
  signatureWidget.FontColor = New PdfRGBColor(0.34, 0.25, 0.36)
  pdfDocumentProcessor.SaveDocument("FormDemo_new.pdf")
End Using