Class AcroFieldBase

Namespace

UglyToad.PdfPig.AcroForms.Fields

Assembly

UglyToad.PdfPig.dll

A field in an interactive AcroForm.

public abstract class AcroFieldBase

Inheritance

object

AcroFieldBase

Derived

AcroCheckboxField

AcroComboBoxField

AcroListBoxField

AcroNonTerminalField

AcroPushButtonField

AcroRadioButtonField

AcroSignatureField

AcroTextField

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AcroFormExtensions.GetFields(AcroFieldBase)

AcroFormExtensions.GetFieldValue(AcroFieldBase)

Constructors

AcroFieldBase(DictionaryToken, string, uint, AcroFieldType, AcroFieldCommonInformation, int?, PdfRectangle?)

Create a new AcroFieldBase.

protected AcroFieldBase(DictionaryToken dictionary, string rawFieldType, uint fieldFlags, AcroFieldType fieldType, AcroFieldCommonInformation information, int? pageNumber, PdfRectangle? bounds)

Parameters

dictionary DictionaryToken

The dictionary for this field.

rawFieldType string

The PDF string type of this field.

fieldFlags uint

The flags specifying behaviour for this field.

fieldType AcroFieldType

The type of this field.

information AcroFieldCommonInformation

Additional information for this field.

pageNumber int?

The number of the page this field appears on.

bounds PdfRectangle?

The location of this field on the page.

Properties

Bounds

The placement rectangle of this form field on the page given by PageNumber if known.

public PdfRectangle? Bounds { get; }

Property Value

PdfRectangle?

Dictionary

The raw PDF dictionary for this field.

public DictionaryToken Dictionary { get; }

Property Value

DictionaryToken

FieldFlags

Specifies various characteristics of the field.

public uint FieldFlags { get; }

Property Value

uint

FieldType

The actual AcroFieldType represented by this field.

public AcroFieldType FieldType { get; }

Property Value

AcroFieldType

Information

The optional information common to all types of field.

public AcroFieldCommonInformation Information { get; }

Property Value

AcroFieldCommonInformation

PageNumber

The page number of the page containing this form field if known.

public int? PageNumber { get; }

Property Value

int?

RawFieldType

The string representing the type of this field in PDF format.

public string RawFieldType { get; }

Property Value

string

Methods

ToString()

public override string ToString()

Returns

string