Search Results for

    Show / Hide Table of Contents

    Class PdfForm

    A collection of the user-editable form fields within a PDF document

    Inheritance
    System.Object
    PdfForm
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: IronPdf.Forms
    Assembly: IronPdf.dll
    Syntax
    public class PdfForm

    Properties

    FieldNames

    Retrieve a new copy of the list of form fields names contained within a PDF document

    Declaration
    public string[] FieldNames { get; }
    Property Value
    Type Description
    System.String[]
    Remarks

    Modifying this list will not affect the PDF document

    Fields

    Retrieve a new copy of the list of form fields contained within a PDF document

    Declaration
    public List<FormField> Fields { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<FormField>
    Remarks

    Generates a snapshot of the form fields currently within the PDF document. Modifying properties of form fields will immediately update the document. Adding or removing from this list will not add or remove fields from the document.

    Methods

    GetFieldByName(String)

    Returns a FormField by its name. This method is fault tolerant and will attempt to match case mistakes and partial field names.

    Declaration
    public FormField GetFieldByName(string FieldName)
    Parameters
    Type Name Description
    System.String FieldName

    The name of the field to be edited. This is analogous to the HTML input 'name' attribute when creating a PDF with forms from HTML using IronPDF.

    Returns
    Type Description
    FormField

    A FormField object

    RenameField(String, String)

    Rename a FormField

    Declaration
    public string RenameField(string CurrentFieldName, string NewFieldName)
    Parameters
    Type Name Description
    System.String CurrentFieldName

    Current fully qualified field name

    System.String NewFieldName

    New partial field name

    Returns
    Type Description
    System.String

    New fully-qualified field name

    Remarks

    Please use a fully qualified field name for CurrentFieldName, and a partial field name for NewFieldName

    Inherited members

    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Free 30-Day Trial Key
    In This Article
    Back to top
    Install with Nuget
    Want to deploy IronPDF to a live project for FREE?
    What’s included?
    30 days of fully-functional product
    Test and share in a live environment
    No watermarks in production
    Get your free 30-day Trial Key instantly.
    No credit card or account creation required
    Your Trial License Key has been emailed to you.
    Download IronPDF free to apply
    your Trial Licenses Key
    Install with NuGet View Licenses
    Licenses from $499. Have a question? Get in touch.