iText pdf library
Website search

Get information from a form

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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2020 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 {@link com.itextpdf.forms.fields.PdfFormField#setValue(String)}?
 * <p>
 * This sample differs from the corresponding iText 5 sample.
 * Here it is described not only how to find out, which values can be set in a checkbox,
 * but it is also shown that values are settable and it can be verified in the resultant pdf.
 */
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.kernel.pdf.PdfWriter;
 
import java.io.File;
import java.util.Map;
 
public class CheckBoxValues {
    public static final String DEST = "./target/sandbox/acroforms/check_box_values.pdf";
 
    public static final String SRC = "./src/test/resources/pdfs/checkboxExample.pdf";
 
    public static final String CHECKED_FIELD_NAME = "checked";
    public static final String UNCHECKED_FIELD_NAME = "unchecked";
 
    public static final String CHECKED_STATE_VALUE = "Yes";
    public static final String UNCHECKED_STATE_VALUE = "Off";
 
 
    public static void main(String[] args) throws Exception {
        File file = new File(DEST);
        file.getParentFile().mkdirs();
 
        new CheckBoxValues().manipulatePdf(DEST);
    }
 
    public void manipulatePdf(String dest) throws Exception {
        PdfDocument pdfDoc = new PdfDocument(new PdfReader(SRC), new PdfWriter(dest));
        PdfAcroForm form = PdfAcroForm.getAcroForm(pdfDoc, true);
        Map<String, PdfFormField> fields = form.getFormFields();
        PdfFormField checkedField = fields.get(CHECKED_FIELD_NAME);
        PdfFormField uncheckedField = fields.get(UNCHECKED_FIELD_NAME);
 
        // Get array of possible values of the checkbox
        String[] states = checkedField.getAppearanceStates();
 
        // See all possible values in the console
        for (String state : states) {
            System.out.print(state + "; ");
        }
 
        // Search and set checked state to the previously unchecked checkbox and vice versa
        for (String state : states) {
            if (state.equals(CHECKED_STATE_VALUE)) {
                uncheckedField.setValue(state);
            } else if (state.equals(UNCHECKED_STATE_VALUE)) {
                checkedField.setValue(state);
            }
        }
 
        pdfDoc.close();
    }
}
CheckBoxValues.cs
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
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2020 iText Group NV
    Authors: iText Software.
 
    For more information, please contact iText Software at this address:
    sales@itextpdf.com
 */
 
using System;
using System.Collections.Generic;
using System.IO;
using iText.Forms;
using iText.Forms.Fields;
using iText.Kernel.Pdf;
 
namespace iText.Samples.Sandbox.Acroforms
{
    public class CheckBoxValues
    {
        public static readonly String DEST = "results/sandbox/acroforms/check_box_values.pdf";
 
        public static readonly String SRC = "../../resources/pdfs/checkboxExample.pdf";
 
        public static readonly String CHECKED_FIELD_NAME = "checked";
        public static readonly String UNCHECKED_FIELD_NAME = "unchecked";
 
        public static readonly String CHECKED_STATE_VALUE = "Yes";
        public static readonly String UNCHECKED_STATE_VALUE = "Off";
 
        public static void Main(String[] args)
        {
            FileInfo file = new FileInfo(DEST);
            file.Directory.Create();
 
            new CheckBoxValues().ManipulatePdf(DEST);
        }
 
        public void ManipulatePdf(String dest)
        {
            PdfDocument pdfDoc = new PdfDocument(new PdfReader(SRC), new PdfWriter(dest));
            PdfAcroForm form = PdfAcroForm.GetAcroForm(pdfDoc, true);
            IDictionary<String, PdfFormField> fields = form.GetFormFields();
            PdfFormField checkedField = fields[CHECKED_FIELD_NAME];
            PdfFormField uncheckedField = fields[UNCHECKED_FIELD_NAME];
 
            // Get array of possible values of the checkbox
            String[] states = checkedField.GetAppearanceStates();
 
            // See all possible values in the console
            foreach (String state in states)
            {
                Console.Write(state + "; ");
            }
 
            // Search and set checked state to the previously unchecked checkbox and vice versa
            foreach (String state in states)
            {
                if (state.Equals(CHECKED_STATE_VALUE))
                {
                    uncheckedField.SetValue(state);
                }
                else if (state.Equals(UNCHECKED_STATE_VALUE))
                {
                    checkedField.SetValue(state);
                }
            }
 
            pdfDoc.Close();
        }
    }
}

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