Table of Contents

Class PdfFormField

Namespace
PdfSharp.Pdf.Forms
Assembly
PdfSharp.dll

Base class for all interactive form (AcroForm) fields. Fields are always created as indirect objects.

public abstract class PdfFormField : PdfDictionary
Inheritance
object
PdfFormField
Derived
Inherited Members
Extension Methods

Constructors

PdfFormField(PdfDictionary)

Initializes a new instance of the PdfFormField class.

Properties

ContainsWidgetPart

Gets a value indicating whether Acro field contains keys of a PdfWidgetAnnotation.

FieldType

Gets the actual type of the field with inheritance considered.

FullName
HasKids

Indicates whether the field has children in the /Kids array.

IsMultiLine

Gets or sets a value indicating whether the field flag Multiline is set. If set to true, a text field may have multiple lines.

IsMultiSelect

Gets or sets a value indicating whether the field flag MultiSelect is set. If set to true, a choice field allows selection of multiple items.

IsNoExport

Gets or sets a value indicating whether the field flag NoExport is set. If set to true, the field shall not be exported.

IsPassword

Gets or sets a value indicating whether the field flag Password is set. If set to true, a text field doesn’t show its content as clear text.

IsReadOnly

Gets or sets a value indicating whether the field flag ReadOnly is set.

IsRequired

Gets or sets a value indicating whether the field flag Required is set. If set to true, the field is required.

Kids

Gets the collection of fields within this field.

Name

Gets or sets the name of this field.

Parent
Value

Gets or sets the value of the field, considering inheritance.

Methods

ClearFlag(PdfFormFieldFlags)
GetDescendants(bool)

Gets all fields within this field recursively.

GetElementsValue<T>(string)

Gets a value of a field entry, considering inheritance.

GetElementsValue<T>(string, out PdfFormField?)

Gets a value of a field entry, considering inheritance.

GetKids(bool)

Gets all fields within this field.

IsFullyQualifiedField()

Returns false, if the field shall not be considered a field but simply a widget annotation.

SetFlag(PdfFormFieldFlags)
SetFlag(PdfFormFieldFlags, bool)
TestFlag(PdfFormFieldFlags)