Skip to main content
All docs
V21.2
.NET Framework 4.5.2+

PdfTextFormFieldFacade Class

Contains a set of properties used to manage text form fields without without access to their inner structure.

Namespace: DevExpress.Pdf

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

Declaration

public class PdfTextFormFieldFacade :
    PdfFormFieldFacade<PdfTextWidgetFacade, PdfTextFormField>

Remarks

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

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;
} 

Change Widget Annotation Settings

A widget annotation contains a form field’s appearance and display properties. One field can be related to multiple widget annotations.

Use the Widgets property to get the form field widgets settings.

The code sample below changes the text form field appearance:

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

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

    //Change all text form fields' color settings:
    var fields = acroForm.GetFields();
    foreach (PdfFormFieldFacade field in fields)
    {
        if (field.Type == PdfFormFieldType.Text)
        {
            ChangeFormFieldColor(field);
        }
    }
}

  private static void ChangeFormFieldColor(PdfFormFieldFacade field)
  {
      foreach (PdfWidgetFacade pdfWidget in field)
      {
          //Change color and border settings

          pdfWidget.BorderWidth = 1;
          pdfWidget.BackgroundColor = new PdfRGBColor(0.81, 0.81, 0.81);
          pdfWidget.BorderColor = new PdfRGBColor(0.47, 0.44, 0.67);
          pdfWidget.FontColor = new PdfRGBColor(0.34, 0.25, 0.36);

          //Change border style:
          pdfWidget.BorderStyle = PdfBorderStyle.Underline;
      }
  }

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PdfTextFormFieldFacade class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also