←Select platform

PDFFormField Class

Summary

Contains information about a single PDF form field.

Syntax

C#
VB
Java
C++
[SerializableAttribute()] 
public class PDFFormField 
<SerializableAttribute()> 
Public Class PDFFormField  
public class PDFFormField 
[SerializableAttribute()] 
public ref class PDFFormField  

Remarks

The PDFFormField class contains the properties of PDF form field objects such as text boxes, check boxes, list boxes, combo boxes and radio buttons. It provides the following form field support:

  • Load Forms Data Format (FDF) files.
  • Load XML Forms Architecture (XFA) files.
  • Read PDF form field information including location, type, etc.
  • Fill in PDF form fields.
  • Save the filled-in data from the PDF forms as XML.
  • Extract the data from filled-in PDF form fields.

The PDFFormField class contains the following members:

Member Description
Bounds

The location and size of the field on the page.

PageNumber

The 1-based number of the page that owns this field.

Name

Name of the field.

AlternateName

Alternate name of the field.

MappingName

Mapping name of the field.

OptionalName

Optional name.

FieldType

The field type (such as text box, check box, list box, combo box or radio button)

ContentType

The content type (such as text, number, date or time).

Contents

List of the contents set in the field

ContentValues

List of values for each content if the field supports multiple values.

MaxLength

Maximum length of the field content.

GroupId

Optional ID if this field is part of a group.

SelectedContents

The selected contents if this field is a list box.

State

State of the field if supported such as a selected or cleared radio button.

ViewFlags

View flags associated with the field.

FieldFlags

Other flags associated with the field.

FillMode

Fill mode of this field.

FillColor

Background color of the field.

BorderStyle

Border style.

BorderWidth

Border width.

BorderColor

Border color.

TextColor

Foreground (text) color

FontName

Font name to use with the text of this field.

FontSize

Font size to use with the text of this field.

TextJustification

Justification to use for text of this field.

Rotation

Rotation angle of the field.

LEADTOOLS supports loading all form fields from a PDF file. Due to the nature and complexity of PDF form fields, (especially the prevalent use of PDF files that contain many custom and user-defined fields), LEADTOOLS reads the data as is and sets it in PDFFormField without any modification. Refer to the PDF Form Fields Demo for an example of parsing data to generate a live, editable PDF file.

Requirements

Target Platforms

Help Version 19.0.2017.10.27 (updated 8/23/2018)
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Pdf Assembly