Click or drag to resize

PdfFieldCollection Class

Represents a collection of all fields in an interactive form.
Inheritance Hierarchy
SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.PdfPdfCollection
      SautinSoft.PdfPdfCollectionPdfField
        SautinSoft.Pdf.FormsPdfFieldCollection

Namespace: SautinSoft.Pdf.Forms
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.8.8
Syntax
Copy
public sealed class PdfFieldCollection : PdfCollection<PdfField>, 
	IList, ICollection, IEnumerable, IList<PdfField>, 
	ICollection<PdfField>, IEnumerable<PdfField>

The PdfFieldCollection type exposes the following members.

Properties
 NameDescription
Public propertyCount Gets the number of elements contained in the PdfCollection.
(Inherited from PdfCollection)
Public propertyItemInt32 Gets or sets the element at the specified index.
(Inherited from PdfCollectionT)
Public propertyItemString Gets the first occurrence of a PdfField with the specified (fully qualified) field name or .
Public propertyMetadata(Optional; PDF 1.4) A metadata stream containing metadata for the component.
(Inherited from PdfObject)
Public propertyNewRadioButtonName Gets or sets the name that will be applied to the newly created PdfRadioButtonField.
Top
Methods
 NameDescription
Public methodAdd Adds an element to the end of the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodAddButton

Adds a new PdfButtonField to the PdfFieldCollection.

Its associated widget annotation will be added to the page and annotation's rectangle will be defined by left, bottom, width and height in default user space units.

Its Name will be automatically set.

Public methodAddCheckBox

Adds a new PdfCheckBoxField to the PdfFieldCollection.

Its associated widget annotation will be added to the page and annotation's rectangle will be defined by left, bottom, width and height in default user space units.

Its Name will be automatically set.

Public methodAddDropdown

Adds a new PdfDropdownField to the PdfFieldCollection.

Its associated widget annotation will be added to the page and annotation's rectangle will be defined by left, bottom, width and height in default user space units.

Its Name will be automatically set.

Public methodAddListBox

Adds a new PdfListBoxField to the PdfFieldCollection.

Its associated widget annotation will be added to the page and annotation's rectangle will be defined by left, bottom, width and height in default user space units.

Its Name will be automatically set.

Public methodAddRadioButton

Adds a new PdfRadioButtonField to the PdfFieldCollection.

Its associated widget annotation will be added to the page and annotation's rectangle will be defined by left, bottom, width and height in default user space units.

Its Name will be automatically set to the value of NewRadioButtonName.

Public methodAddSignature

Adds a new invisible PdfSignatureField to the PdfFieldCollection.

Its associated widget annotation will be added to the first page of the Pages and annotation's rectangle will have zero height and width, thus making the signature invisible.

Its Name will be automatically set.

Public methodAddSignature(PdfPage, Double, Double, Double, Double)

Adds a new visible PdfSignatureField to the PdfFieldCollection.

Its associated widget annotation will be added to the page and annotation's rectangle will be defined by left, bottom, width and height in default user space units.

Its Name will be automatically set.

Public methodAddText

Adds a new PdfTextField to the PdfFieldCollection.

Its associated widget annotation will be added to the page and annotation's rectangle will be defined by left, bottom, width and height in default user space units.

Its Name will be automatically set.

Public methodClear Removes all elements from the PdfCollection.
(Inherited from PdfCollection)
Public methodContains Determines whether an element is in the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodCopyTo Copies the entire PdfCollectionT to a compatible one-dimensional array, starting at the specified index of the target array.
(Inherited from PdfCollectionT)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetEnumerator Returns an enumerator that iterates through the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIndexOf Searches for the specified element and returns the zero-based index of the first occurrence within the entire PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodInsert Inserts an element into the PdfCollectionT at the specified index.
(Inherited from PdfCollectionT)
Public methodRefresh

Forces an update of the PdfFieldCollection to include all PdfFields contained in the Annotations of all Pages that are not already contained in the PdfFieldCollection.

This method also handles the invalid AcroForm entry in the Catalog dictionary and updates the Page property of all PdfAnnotations in the PdfDocument.

Public methodRemove Removes the first occurrence of a specific element from the PdfCollectionT.
(Inherited from PdfCollectionT)
Public methodRemoveAt Removes the element at the specified index of the PdfCollection.
(Inherited from PdfCollection)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfCollection.
(Defined by PdfObjectExtensions)
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddArray Gets the PdfArray that serves as a backing storage of the specified PdfCollection.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
See Also