API Reference
PdfFormField
Simple AcroForm field information read from a PDF document.
Inheritance
- Object
- PdfFormField
Usage
Explore 17 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 14
- Property PdfAcroFormEditResult.Fields
- Method PdfDocumentInfo.GetFormFields
- Property PdfDocumentInfo.FormFields
- Property PdfDocumentInfo.FormFieldsByKind
- Property PdfDocumentInfo.FormFieldsByName
- Property PdfDocumentInfo.FormFieldsByPageNumber
- Method PdfDocumentReadResult.GetFormFields
- Property PdfDocumentReadResult.FormFields
- Property PdfDocumentReadResult.FormFieldsByKind
- Property PdfDocumentReadResult.FormFieldsByName
- Property PdfDocumentReadResult.FormFieldsByPageNumber
- Property PdfFormInteractionInfo.Fields
- Property PdfLogicalFormWidget.Field
- Property PdfReadDocument.FormFields
Accepted by parameters 3
Methods
public IReadOnlyList<PdfFormWidget> GetWidgets(Int32 pageNumber) #IReadOnlyList<PdfFormWidget>Returns readable widget annotations for this field on a one-based page number.
Parameters
- pageNumber System.Int32
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public IReadOnlyList<PdfFormWidgetAction> Actions { get; } #Actions attached to a separate field dictionary; merged widgets expose their actions on the widget.
public Int32? ObjectNumber { get; } #Indirect object number for the field dictionary, when known.
public String? Name { get; } #Fully qualified field name when a name can be read.
public String? PartialName { get; } #Partial field name from the field dictionary.
public String? FieldType { get; } #Field type name, for example Tx, Btn, Ch, or Sig, when present or inherited.
public PdfFormFieldKind Kind { get; } #Common field kind inferred from PdfFormField.FieldType.
public String? Value { get; } #Simple field value formatted for wrapper display, when present.
public IReadOnlyList<String> Values { get; } #Simple field values from /V, preserving array values for multi-select choice fields.
public Boolean HasValues { get; } #True when at least one simple field value was readable.
public String? DefaultValue { get; } #Simple default field value formatted for wrapper display, when present.
public IReadOnlyList<String> DefaultValues { get; } #Simple default field values from /DV, preserving array values for multi-select choice fields.
public Int32 DefaultValueCount { get; } #Number of readable default field values.
public Boolean HasDefaultValues { get; } #True when at least one simple default field value was readable.
public String? RichValuePlainText { get; } #Plain-text projection of PdfFormField.RichValue, when readable.
public Boolean HasRichValue { get; } #True when a rich-text field value was readable.
public String? AlternateName { get; } #Alternate field name used as a user-facing label, when present.
public String? MappingName { get; } #Mapping name used for export workflows, when present.
public Int32? MaxLength { get; } #Maximum text length from /MaxLen, when present on a simple field.
public String? DefaultAppearance { get; } #Default appearance string from /DA, when present or inherited.
public Boolean HasDefaultAppearance { get; } #True when a default appearance string was readable.
public Int32? Quadding { get; } #Raw AcroForm /Q quadding value, when present or inherited.
public PdfFormFieldTextAlignment TextAlignment { get; } #Common text alignment inferred from /Q quadding.
public IReadOnlyList<PdfFormFieldOption> Options { get; } #Choice field options from /Opt, when readable.
public Boolean HasOptions { get; } #True when at least one choice option was readable.
public IReadOnlyList<Int32> SelectedIndices { get; } #Zero-based selected choice-option indices from /I, when readable.
public IReadOnlyList<PdfFormFieldOption> SelectedOptions { get; } #Readable choice options identified by /I or, when absent, whose export value matches the field value list.
public Int32 SelectedOptionCount { get; } #Number of readable choice options whose export value matches the field value list.
public Boolean HasSelectedOptions { get; } #True when at least one readable choice option matches the field value list.
public IReadOnlyList<PdfFormFieldOption> DefaultSelectedOptions { get; } #Readable choice options whose export value matches the default field value list.
public Int32 DefaultSelectedOptionCount { get; } #Number of readable choice options whose export value matches the default field value list.
public Boolean HasDefaultSelectedOptions { get; } #True when at least one readable choice option matches the default field value list.
public Boolean IsReadOnly { get; } #True when the common read-only field flag is set.
public Boolean IsRequired { get; } #True when the common required field flag is set.
public Boolean IsNoExport { get; } #True when the common no-export field flag is set.
public Boolean IsMultiline { get; } #True when a text field has the multiline flag set.
public Boolean IsPassword { get; } #True when a text field has the password flag set.
public Boolean IsFileSelect { get; } #True when a text field has the file-select flag set.
public Boolean DoesNotSpellCheck { get; } #True when a text or choice field disables spell checking.
public Boolean DoesNotScroll { get; } #True when a text field disables scrolling.
public Boolean IsRichText { get; } #True when a text field has the rich-text flag set.
public Boolean IsRadioButton { get; } #True when a button field is a radio button.
public Boolean IsNoToggleToOff { get; } #True when a button field has the no-toggle-to-off flag set.
public Boolean IsCheckBox { get; } #True when a button field is a check box rather than a push button or radio button.
public Boolean IsEditableChoice { get; } #True when a choice combo box allows direct text editing.
public Boolean IsSortedChoice { get; } #True when a choice field asks viewers to sort options.
public Boolean AllowsMultipleSelection { get; } #True when a choice field allows multiple selections.
public Boolean CommitsOnSelectionChange { get; } #True when a choice field commits values immediately when the selected item changes.
public IReadOnlyList<PdfFormWidget> Widgets { get; } #Simple widget annotations that visually represent this field, when readable.
public Boolean HasUnplacedContent { get; } #Whether this field has no widgets or has a widget not attached to a readable page.
public Int32 WidgetCount { get; } #Number of readable widget annotations associated with this field.
public Boolean HasWidgets { get; } #True when at least one widget annotation was associated with this field.
public String? JavaScript { get; } #First readable JavaScript source attached to this field or one of its widgets, when present.
public Boolean HasJavaScript { get; } #True when the field or at least one widget exposes a readable JavaScript action.
public IReadOnlyList<Int32> PageNumbers { get; } #Distinct one-based page numbers where this field has readable widget annotations.
public Int32 PageNumberCount { get; } #Number of distinct readable page numbers where this field has widgets.
public Boolean HasPageNumbers { get; } #True when at least one widget for this field has a readable page number.
public IReadOnlyDictionary<Int32, IReadOnlyList<PdfFormWidget>> WidgetsByPageNumber { get; } #Readable widget annotations for this field grouped by one-based page number.