API Reference

Class

PdfFormWidget

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Simple AcroForm widget annotation geometry read from a PDF document.

Inheritance

  • Object
  • PdfFormWidget

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Methods

public Boolean HasNormalAppearanceState(String state) #
Returns: Boolean

Returns true when the widget exposes a matching normal appearance state name.

Parameters

state System.String requiredposition: 0

Properties

public Nullable<Int32> ObjectNumber { get; } #

Indirect object number for the widget annotation, when known.

public String FieldName { get; } #

Fully qualified form field name associated with the widget, when known.

public Nullable<Int32> PageNumber { get; } #

One-based page number containing 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 IsHidden { get; } #

True when the widget has the PDF annotation Hidden 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.