Renaming a field

This is a code example of iText PDF, discover more.

31st May 2016
iText PDF

Example that explains how to rename a field.

RenameField.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2019 iText Group NV
    Authors: iText Software.
 
    For more information, please contact iText Software at this address:
    sales@itextpdf.com
 */
/**
 * Example written by Bruno Lowagie in answer to:
 * http://stackoverflow.com/questions/21344750/itextsharp-renamefield-bug
 * <p>
 * When renaming a field, you need to respect the existing hierarchy.
 */
package com.itextpdf.samples.sandbox.acroforms;
 
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfReader;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.test.annotations.type.SampleTest;
import com.itextpdf.forms.PdfAcroForm;
import com.itextpdf.forms.fields.PdfFormField;
 
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
 
import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.experimental.categories.Category;
 
@Category(SampleTest.class)
public class RenameField {
    public static final String DEST = "./target/test/resources/sandbox/acroforms/rename_field.pdf";
    public static final String SRC = "./src/test/resources/pdfs/subscribe.pdf";
    public static List<String> CMP_RESULT;
 
    static {
        CMP_RESULT = new ArrayList<String>();
        CMP_RESULT.add("personal");
        CMP_RESULT.add("personal.name");
        CMP_RESULT.add("personal.login");
        CMP_RESULT.add("personal.password");
        CMP_RESULT.add("personal.reason");
    }
 
    @BeforeClass
    public static void beforeClass() throws Exception {
        File file = new File(DEST);
        file.getParentFile().mkdirs();
    }
 
    @Test
    public void manipulatePdf() throws Exception {
        PdfDocument pdfDoc = new PdfDocument(new PdfReader(SRC), new PdfWriter(DEST));
        PdfAcroForm form = PdfAcroForm.getAcroForm(pdfDoc, true);
 
        PdfFormField login = form.getField("personal.loginname");
        login.setFieldName("login");
        form.getFormFields().remove("personal.loginname");
        form.getFormFields().put("login", login);
 
        pdfDoc.close();
 
        pdfDoc = new PdfDocument(new PdfReader(DEST));
 
        Map<String, PdfFormField> fields = PdfAcroForm.getAcroForm(pdfDoc, true).getFormFields();
        List<String> result = new ArrayList<>();
        for (String name : fields.keySet()) {
            System.out.println(name);
            result.add(name);
        }
 
        pdfDoc.close();
 
        Assert.assertArrayEquals(CMP_RESULT.toArray(), result.toArray());
    }
}

Resources

Click the following link to see the legacy example for iText 5. Except for security fixes, iText 5 is no longer being developed.



Contact

Still have questions? 

We're happy to answer your questions. Reach out to us and we'll get back to you shortly.

Contact us
Stay updated

Join 11,000+ subscribers and become an iText PDF expert by staying up to date with our new products, updates, tips, technical solutions and happenings.

Subscribe Now