API Reference
ReaderFormField
Structured form field metadata extracted from a source document.
Inheritance
- Object
- ReaderFormField
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property ReaderChunk.FormFields
Constructors
public ReaderFormField() #Inherited Methods
Properties
public String Name { get; set; } #Fully qualified source field name, when available.
public String PartialName { get; set; } #Partial source field name, when available.
public String AlternateName { get; set; } #User-facing alternate field name or label, when available.
public String MappingName { get; set; } #Export or mapping name, when available.
public String FieldType { get; set; } #Source-specific field type token, for example Tx, Btn, Ch, or Sig for PDF.
public ReaderFormFieldKind Kind { get; set; } #Source-neutral form field kind.
public String Value { get; set; } #Simple source value, when available.
public IReadOnlyList<String> Values { get; set; } #Simple source values, preserving multi-select values when available.
public String DefaultValue { get; set; } #Simple default value, when available.
public IReadOnlyList<String> DefaultValues { get; set; } #Simple default values, preserving multi-select defaults when available.
public Nullable<Int32> MaxLength { get; set; } #Maximum text length, when the source exposes one.
public Boolean IsReadOnly { get; set; } #True when the source marks the field read-only.
public Boolean IsRequired { get; set; } #True when the source marks the field required.
public Boolean IsNoExport { get; set; } #True when the source marks the field as excluded from export.
public Boolean IsMultiline { get; set; } #True when a text field allows multiple lines.
public Boolean IsPassword { get; set; } #True when a text field is password-like.
public Boolean IsComb { get; set; } #True when a text field uses comb formatting.
public Int32 OptionCount { get; set; } #Number of readable choice options, when applicable.
public Int32 SelectedOptionCount { get; set; } #Number of readable choice options selected by the current value, when applicable.
public Int32 WidgetCount { get; set; } #Number of visible source widgets associated with this field in the chunk scope.
public IReadOnlyList<Int32> PageNumbers { get; set; } #One-based page numbers where this field has widgets in the chunk scope.
public IReadOnlyList<ReaderFormWidget> Widgets { get; set; } #Widget placement details associated with this field in the chunk scope.