ReaderFormField
OfficeIMO.Reader
Structured form field metadata extracted from a source document.
Inheritance
- object
- ReaderFormField
Usage
Explore 1 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 1
- 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 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 int? MaxLength { get; set; } #Maximum text length, when the source exposes one.
public bool IsReadOnly { get; set; } #True when the source marks the field read-only.
public bool IsRequired { get; set; } #True when the source marks the field required.
public bool IsNoExport { get; set; } #True when the source marks the field as excluded from export.
public bool IsMultiline { get; set; } #True when a text field allows multiple lines.
public bool IsPassword { get; set; } #True when a text field is password-like.
public bool IsComb { get; set; } #True when a text field uses comb formatting.
public int OptionCount { get; set; } #Number of readable choice options, when applicable.
public int SelectedOptionCount { get; set; } #Number of readable choice options selected by the current value, when applicable.
public int WidgetCount { get; set; } #Number of visible source widgets associated with this field in the chunk scope.
public IReadOnlyList<int> 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.