PdfAcroFormFacade.GetTextFormField(String) Method

Gets a specific text form field’s properties.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v23.2.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public PdfTextFormFieldFacade GetTextFormField(
    string fullName
)

VB.NET

Public Function GetTextFormField(
    fullName As String
) As PdfTextFormFieldFacade

Parameters

Name	Type	Description
fullName	String	The form field name.

Returns

Type	Description
PdfTextFormFieldFacade	An object that contains the form field properties.

Remarks

The PdfTextFormFieldFacade 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 widgets’ settings.

The code sample below divides one form field into equally spaced positions (combs) and enables multiline text in the other form field:

C#

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

    PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
    PdfAcroFormFacade acroForm = documentFacade.AcroForm;
    PdfTextFormFieldFacade visaField = acroForm.GetTextFormField("VisaNo");

    //Divide field text into equally spaced positions:
    visaField.InputType = PdfTextFieldInputType.Comb;
    visaField.Multiline = false;

    //Limit the number of inserted characters:
    visaField.MaxLength = 8;

    //Enable multiline text in the text field:
    PdfTextFormFieldFacade addressField = acroForm.GetTextFormField("Address");
    addressField.Multiline = true;

    addressField.Scrollable = true;
    addressField.SpellCheck = false;
    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 visaField As PdfTextFormFieldFacade = acroForm.GetTextFormField("VisaNo")

  'Divide field text into equally spaced positions:
  visaField.InputType = PdfTextFieldInputType.Comb
  visaField.Multiline = False

  'Limit the number of inserted characters:
  visaField.MaxLength = 8

  'Enable multiline text in the text field:
  Dim addressField As PdfTextFormFieldFacade = acroForm.GetTextFormField("Address")
  addressField.Multiline = True

  addressField.Scrollable = True
  addressField.SpellCheck = False
  pdfDocumentProcessor.SaveDocument("FormDemo_new.pdf")
End Using