Class FormField

Generic base class from which all PDF Form fields are derived.

Inheritance
System.Object
PdfClientAccessor
FormField
CheckBoxField
ComboBoxField
TextField
Implements
Namespace: IronPdf.Forms
Assembly: IronPdf.dll
Syntax
public class FormField : PdfClientAccessor, IFormField

Properties

AnnotationIndex

Index of annotation associated with this form field

Declaration
public int AnnotationIndex { get; }
Property Value
Type Description
System.Int32

FullName

Gets the fully qualified name of this field. This is constructed from all partial field names of the field and all of its ancestors.

Example 1: 

parent's_full_name.child's_partial_name
Example 2: 
PersonalData.Address.ZipCode

Declaration
public string FullName { get; }
Property Value
Type Description
System.String

The fully qualified name as a string.

Height

Form field height

Declaration
public double Height { get; }
Property Value
Type Description
System.Double

Name

Gets the ID name of this field.

Declaration
public string Name { get; }
Property Value
Type Description
System.String

The name as a string.

PageIndex

Page index which contains this form field

Declaration
public int PageIndex { get; }
Property Value
Type Description
System.Int32

PdfDocumentId

Declaration
public IPdfDocumentId PdfDocumentId { get; }
Property Value
Type Description
IronSoftware.IPdfDocumentId

ReadOnly

Gets or sets the permissions for users to fill-in current form field.

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

true if form field is readonly, otherwise false.

Type

Form field type

Declaration
public FormFieldTypes Type { get; }
Property Value
Type Description
FormFieldTypes

Value

Gets the value of the editable PDF field.

Declaration
public string Value { get; set; }
Property Value
Type Description
System.String

The value.

Width

Form field width

Declaration
public double Width { get; }
Property Value
Type Description
System.Double

X

Form field x position

Declaration
public double X { get; }
Property Value
Type Description
System.Double

Y

Form field x position

Declaration
public double Y { get; }
Property Value
Type Description
System.Double

Methods

SetFont(FontTypes, Double)

Sets the font to the text field of pdf form.

Declaration
public virtual void SetFont(FontTypes fontType, double fontSize = 11)
Parameters
Type Name Description
IronSoftware.Drawing.FontTypes fontType

Type of the font.
System.Double fontSize

Size of the font.

ToString()

Returns the value of this field.

Declaration
public override string ToString()
Returns
Type Description
System.String

The value of this field.

Implements