PdfDocumentProcessor.RemoveFormField(String) Method

Removes an interactive form field from a document using the field name.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v19.1.dll

Declaration

C#

public bool RemoveFormField(
    string name
)

VB.NET

Public Function RemoveFormField(
    name As String
) As Boolean

Parameters

Name	Type	Description
name	String	A String which specifies the name of form field.

Returns

Type	Description
Boolean	If the form field was removed from a PDF document, the value is true; otherwise, false.

Remarks

The RemoveFormField method tries to find the field in a document using the field name. If this field is found in the document, then it will be removed from a document and this method returns true; otherwise, it returns false.

Example

This example shows how to remove a particular form field and a whole interactive form from a PDF document.

To remove all form fields from a document, call the PdfDocumentProcessor.RemoveForm method.

If the interactive form is removed successfully, this method returns true. If the document doesn’t contain an interactive form that should be removed, this method returns false.

To remove a particular form field by its name, call the PdfDocumentProcessor.RemoveFormField method and pass a field name as an argument to this method.

The PdfDocumentProcessor.RemoveFormField method tries to find the field in a document using the field name. If this field is found in the document, then it will be removed from a document and this method returns true; otherwise, it returns false.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-delete-interactive-form-fields-from-a-pdf-document-t494240

Program.vb

Imports DevExpress.Pdf
Imports System

Namespace RemoveInteractiveForm
    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            Using processor As New PdfDocumentProcessor()

                ' Load a document with an interactive form.
                processor.LoadDocument("..\..\InteractiveForm.pdf")

                ' Remove a form field by its name.
                If processor.RemoveFormField("FirstName") Then

                    ' Save the modified document.
                    processor.SaveDocument("..\..\Result1.pdf")

                Else

                    ' Show a message if the form field was not found in a document.
                    Console.WriteLine("The form field was not removed from a document. Make sure, the form field exists in the document.")
                End If

                ' Remove the whole interactive form.
                If processor.RemoveForm() Then

                    ' Save the modified document.
                    processor.SaveDocument("..\..\Result2.pdf")

                Else

                    ' Show a message if the interactive form was not found in a document.
                    Console.WriteLine("The interactive form was not removed from a document. Make sure the interactive form exists in the document.")
                End If
            End Using
        End Sub
    End Class
End Namespace

Program.cs

using DevExpress.Pdf;
using System;

namespace RemoveInteractiveForm {
    class Program {
        static void Main(string[] args) {
            using (PdfDocumentProcessor processor = new PdfDocumentProcessor()) {

                // Load a document with an interactive form.
                processor.LoadDocument("..\\..\\InteractiveForm.pdf");

                // Remove a form field by its name.
                if (processor.RemoveFormField("FirstName"))

                    // Save the modified document.
                    processor.SaveDocument("..\\..\\Result1.pdf");

                else

                    // Show a message if the form field was not found in a document.
                    Console.WriteLine("The form field was not removed from a document. Make sure, the form field exists in the document.");

                // Remove the whole interactive form.
                if (processor.RemoveForm())

                    // Save the modified document.
                    processor.SaveDocument("..\\..\\Result2.pdf");

                else

                    // Show a message if the interactive form was not found in a document.
                    Console.WriteLine("The interactive form was not removed from a document. Make sure the interactive form exists in the document.");
            }
        }
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RemoveFormField(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

pdf-document-api-remove-interactive-form-field/CS/RemoveInteractiveForm/Program.cs#L12

// Remove a form field by its name.
processor.RemoveFormField("FirstName");

VB.NET

pdf-document-api-remove-interactive-form-field/VB/RemoveInteractiveForm/Program.vb#L12

' Remove a form field by its name.
processor.RemoveFormField("FirstName")
' Save the result document.

pdf-document-api-remove-interactive-form-fields/VB/RemoveInteractiveForm/Program.vb#L13

' Remove a form field by its name.
If processor.RemoveFormField("FirstName") Then
    ' Save the modified document.

pdf-document-api-replace-form-field-with-image/VB/ReplaceFormFieldWithImage/Program.vb#L26

processor.RemoveFormField("Address")
processor.SaveDocument("..\..\Result.pdf")