Change Export-Value of PDFAcroCheckBox

[Mystificious]

Hello everybody,

I have the need to adjust the export-value of a checkbox created with pdf-lib.
The default of "Yes" is not appropriate for my project.

I found the possibility of getOnValue that gives me value back.
But I couldn't find any setter-function in the PDFCheckBox, PDFAcroCheckBox, PDFAcroButton or PDFAcroTerminal classes.

How do I accomplish such a task while creating the object?

Best,
Arthur from Berlin

[Mystificious]

If anybody is interested, I solved it by the following code...

Still seems pretty tacky for me, but works. It's important, that the widgets are only changed after adding the checkbox to the page.

        const form = pdfDoc.getForm();
        const checkbox = form.createCheckBox(props.key);
        const pageHeight = page.getHeight();
        const { width, height, position } = convertForPdfLayoutProps({ schema, pageHeight });
        const { x, y } = position;
        const borderColor = hex2PrintingColor(schema.borderColor ?? DEFAULT_FONT_COLOR, 'rgb');
        const background = hex2PrintingColor(schema.backgroundColor ?? DEFAULT_BACKGROUND_COLOR, 'rgb');

        const inputAppearance =
            checkbox.acroField.getDefaultAppearance() ??
            '' + '\n' + setFontAndSize(DEFAULT_FONT_NAME, DEFAULT_FONT_SIZE).toString();
        checkbox.acroField.setDefaultAppearance(inputAppearance);

        checkbox.addToPage(page, {
            x: x,
            y: y,
            width: width,
            height: height,
            borderColor: borderColor,
            backgroundColor: background,
        });

        // Anpassen der True/False-Werte, da diese im default immer Yes/No sind bei PDF-Lib:
        const widgets = checkbox.acroField.getWidgets();
        widgets.forEach((widget) => {
            const allAp = widget.getAppearances();

            const trueName = PDFName.of(schema.exportValue ?? 'true');
            const falseName = PDFName.of(schema.exportValue ?? 'false');

            // set Normal Appearance:
            if (allAp?.normal instanceof PDFDict) {
                const newValueDictNormal = allAp.normal;
                const curYesAp = allAp.normal.get(PDFName.of('Yes'));
                const curOffAp = allAp.normal.get(PDFName.of('Off'));
                newValueDictNormal.delete(PDFName.of('Yes'));
                newValueDictNormal.delete(PDFName.of('Off'));
                if (curYesAp) newValueDictNormal.set(trueName, curYesAp);
                if (curOffAp) newValueDictNormal.set(falseName, curOffAp);

                widget.setNormalAppearance(newValueDictNormal);
            }

            // set Down Appearance:
            if (allAp?.down instanceof PDFDict) {
                const newValueDictDown = allAp.down;
                const curYesAp = allAp.down.get(PDFName.of('Yes'));
                const curOffAp = allAp.down.get(PDFName.of('Off'));
                newValueDictDown.delete(PDFName.of('Yes'));
                newValueDictDown.delete(PDFName.of('Off'));

                if (curYesAp) newValueDictDown.set(trueName, curYesAp);
                if (curOffAp) newValueDictDown.set(falseName, curOffAp);

                widget.setDownAppearance(newValueDictDown);
            }
        });

        checkbox.updateAppearances();