API Reference
PdfLogicalFormWidget
AcroForm widget annotation entry in the logical page model.
Inheritance
- Object
- PdfLogicalFormWidget
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
- Method PdfDocumentReader.FormWidgets
- Method PdfDocumentReader.FormWidgets
- Method PdfDocumentReader.FormWidgets
- Method PdfDocumentReader.TryFormWidgets
- Method PdfDocumentReader.TryFormWidgets
- Method PdfDocumentReader.TryFormWidgets
- Method PdfLogicalDocument.GetFormWidgets
- Method PdfLogicalDocument.GetFormWidgets
- Property PdfLogicalDocument.FormWidgets
- Property PdfLogicalDocument.FormWidgetsByFieldName
- Property PdfLogicalDocument.FormWidgetsByPageNumber
- Property PdfLogicalPage.FormWidgets
Methods
public Boolean HasNormalAppearanceState(String state) #BooleanReturns true when the widget exposes a matching normal appearance state name.
Parameters
- state System.String
Inherited Methods
Properties
public virtual Int32 PageNumber { get; } #public virtual PdfLogicalElementKind Kind { get; } #public PdfFormField Field { get; } #Field represented by this widget annotation.
public PdfFormWidget SourceWidget { get; } #Underlying parsed widget annotation.
public String FieldName { get; } #Fully qualified field name when a name can be read.
public String FieldType { get; } #Field type name, for example Tx, Btn, Ch, or Sig, when present or inherited.
public String Value { get; } #Simple field value formatted for wrapper display, when present.
public Nullable<Int32> ObjectNumber { get; } #Indirect object number for the widget annotation, when known.
public Double X1 { get; } #Left edge of the widget rectangle in PDF points.
public Double Y1 { get; } #Bottom edge of the widget rectangle in PDF points.
public Double X2 { get; } #Right edge of the widget rectangle in PDF points.
public Double Y2 { get; } #Top edge of the widget rectangle in PDF points.
public Double Width { get; } #Rectangle width in PDF points.
public Double Height { get; } #Rectangle height in PDF points.
public String AppearanceState { get; } #Current widget appearance state name from /AS, when present.
public Nullable<Int32> Flags { get; } #Raw widget annotation flags from /F, when present.
public Boolean IsInvisible { get; } #True when the widget has the PDF annotation Invisible flag.
public Boolean IsPrint { get; } #True when the widget has the PDF annotation Print flag.
public Boolean IsNoZoom { get; } #True when the widget has the PDF annotation NoZoom flag.
public Boolean IsNoRotate { get; } #True when the widget has the PDF annotation NoRotate flag.
public Boolean IsNoView { get; } #True when the widget has the PDF annotation NoView flag.
public Boolean IsReadOnly { get; } #True when the widget has the PDF annotation ReadOnly flag.
public Boolean IsLocked { get; } #True when the widget has the PDF annotation Locked flag.
public Boolean IsToggleNoView { get; } #True when the widget has the PDF annotation ToggleNoView flag.
public Boolean IsLockedContents { get; } #True when the widget has the PDF annotation LockedContents flag.
public IReadOnlyList<String> NormalAppearanceStates { get; } #Normal appearance state names from /AP /N, when the widget exposes named appearance streams.
public Int32 NormalAppearanceStateCount { get; } #Number of readable normal appearance states.
public Boolean HasNormalAppearanceStates { get; } #True when at least one normal appearance state was readable.