Class PdfFormFieldInfo

Namespace

LMKit.Document.Pdf

Assembly

LM-Kit.NET.dll

A read-only description of one interactive form field widget: its name, kind, current value, options, flags, and page geometry. Instances are produced by GetFields(string, CancellationToken) as part of a PdfFormSnapshot.

public sealed class PdfFormFieldInfo

Inheritance

object

PdfFormFieldInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Each entry describes one widget annotation. Radio buttons of the same group therefore appear as several entries sharing a Name, each with its own ExportValue and Bounds.

Properties

Bounds

Gets the widget's bounding box in page points, with the origin at the top-left corner of the page, matching the geometry used by PdfRedactionArea and the layout APIs.

ExportValue

Gets the export value of a checkbox or radio button widget. Empty for other kinds.

IsChecked

Gets whether this checkbox or radio button widget is checked. Always false for other kinds.

IsReadOnly

Gets whether the field is read-only and therefore refuses new values.

IsRequired

Gets whether the field is marked as required by the form.

Kind

Gets the field kind.

Label

Gets the field's alternate (display) name, typically shown as a tooltip. Empty when the document defines none.

Name

Gets the fully qualified field name. This is the name PdfFormFieldValue addresses the field by.

Options

Gets the option labels of a combo box or list box, in document order. Empty outside choice fields.

PageIndex

Gets the zero-based index of the page carrying the widget.

SelectedOptions

Gets the labels of the currently selected options of a combo box or list box. Empty outside choice fields.

Value

Gets the field's current value as a string. For checkboxes and radio buttons this is the state name (for example "Off").