Interface IFormField

Form field interface from which all form fields inherit.

Namespace: PSPDFKit.Pdf.Form

Assembly: PSPDFKit.dll

Syntax

public interface IFormField

Properties

AnnotationIDs

A list of Id.

Declaration

IList<string> AnnotationIDs { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Label

Used to identify the form field in the UI or for accessibility.

Declaration

string Label { get; set; }

Property Value

Type	Description
System.String

Name

Unique name of the form field (often referred to as fully qualified name). This name is used to link Widget annotations and is also used as an identifier for form field values.

Declaration

string Name { get; set; }

Property Value

Type	Description
System.String

NoExport

Determines if the form field will appear in the serialized payload of a form submission. Defaults to false.

Declaration

bool NoExport { get; set; }

Property Value

Type	Description
System.Boolean

PdfObjectId

The object ID of the form field object in the PDF.

Declaration

int PdfObjectId { get; set; }

Property Value

Type	Description
System.Int32

ReadOnly

Read only form fields can not be filled out. Defaults to false.

Declaration

bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

Required

Required form fields must be filled out in order to submit the form. Defaults to false.

Declaration

bool Required { get; set; }

Property Value

Type	Description
System.Boolean