Get information from a form

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

31st May 2016
iText PDF

This example was written in answer to the question How to check a check box?

CheckBoxValues.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
/*
    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/19698771/checking-off-pdf-checkbox-with-itextsharp
 * <p>
 * Given a check box in a form, how do we know which values to use in setField?
 */
package com.itextpdf.samples.sandbox.acroforms;
 
import com.itextpdf.forms.PdfAcroForm;
import com.itextpdf.forms.fields.PdfFormField;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfReader;
import com.itextpdf.test.annotations.type.SampleTest;
import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.experimental.categories.Category;
 
import java.util.Map;
 
@Category(SampleTest.class)
public class CheckBoxValues {
    public static final String CMP = "Off\nYes\n";
    public static final String DEST = "./target/test/resources/sandbox/acroforms/check_box_values.pdf";
    public static final String FIELD = "CP_1";
    public static final String SRC = "./src/test/resources/pdfs/datasheet.pdf";
 
    @BeforeClass
    public static void beforeClass() throws Exception {
        new CheckBoxValues().manipulatePdf();
    }
 
    @Test
    public void manipulatePdf() throws Exception {
        PdfDocument pdfDoc = new PdfDocument(new PdfReader(SRC));
        PdfAcroForm form = PdfAcroForm.getAcroForm(pdfDoc, true);
 
        Map<String, PdfFormField> fields = form.getFormFields();
        PdfFormField field = fields.get(FIELD);
 
        StringBuilder sb = new StringBuilder();
        String[] states = field.getAppearanceStates();
        for (String state : states) {
            sb.append(state);
            sb.append('\n');
        }
        System.out.println(sb);
 
        pdfDoc.close();
 
        Assert.assertEquals(CMP, sb.toString());
    }
}

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