Class PdfAcroField

Namespace

PdfSharp.Pdf.AcroForms

Assembly

PdfSharp.dll

Represents the base class for all interactive field dictionaries.

public abstract class PdfAcroField : PdfDictionary, ICloneable, IEnumerable<KeyValuePair<string, PdfItem?>>, IEnumerable

Inheritance

object

PdfItem

PdfObject

PdfDictionary

PdfAcroField

Implements

ICloneable

IEnumerable<KeyValuePair<string, PdfItem>>

IEnumerable

Derived

PdfButtonField

PdfChoiceField

PdfGenericField

PdfSignatureField

PdfTextField

Inherited Members

PdfDictionary.Clone()

PdfDictionary.Copy()

PdfDictionary.GetEnumerator()

PdfDictionary.ToString()

PdfDictionary.CreateStream(byte[])

PdfDictionary.Elements

PdfDictionary.Stream

PdfObject.Owner

PdfObject.Comment

PdfObject.IsIndirect

PdfObject.Internals

PdfObject.Reference

PdfObject.ReferenceNotNull

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PdfAcroField(PdfDictionary)

Initializes a new instance of the PdfAcroField class. Used for type transformation.

protected PdfAcroField(PdfDictionary dict)

Parameters

dict PdfDictionary

Properties

DescendantNames

Gets the names of all descendants of this field.

[Obsolete("Use GetDescendantNames")]
public string[] DescendantNames { get; }

Property Value

string[]

Fields

Gets the collection of fields within this field.

public PdfAcroField.PdfAcroFieldCollection Fields { get; }

Property Value

PdfAcroField.PdfAcroFieldCollection

Flags

Gets the field flags of this instance.

public PdfAcroFieldFlags Flags { get; }

Property Value

PdfAcroFieldFlags

HasKids

Indicates whether the field has child fields.

public bool HasKids { get; }

Property Value

bool

this[string]

Gets the field with the specified name.

public PdfAcroField? this[string name] { get; }

Parameters

name string

Property Value

PdfAcroField

Name

Gets the name of this field.

public string Name { get; }

Property Value

string

ReadOnly

Gets or sets a value indicating whether the field is read only.

public bool ReadOnly { get; set; }

Property Value

bool

Value

Gets or sets the value of the field.

public virtual PdfItem? Value { get; set; }

Property Value

PdfItem

Methods

GetAppearanceNames()

Gets the names of all appearance dictionaries of this AcroField.

public string[] GetAppearanceNames()

Returns

string[]

GetDescendantNames()

Gets the names of all descendants of this field.

public string[] GetDescendantNames()

Returns

string[]

GetValue(string)

Gets a child field by name.

protected virtual PdfAcroField? GetValue(string name)

Parameters

name string

Returns

PdfAcroField