Method setValue

src/document/forms/fields/checkbox-field.ts:99–122

* Set the checkbox value. * * This method is async because it regenerates the field's appearance * stream after setting the value. * * @param value "Off" or one of the on-values * @throws {Error} if field is read-only or value is invalid

(value: string)

   * @throws {Error} if field is read-only or value is invalid
   */
  setValue(value: string): void {
    this.assertWritable();

    // Validate value
    if (value !== "Off" && !this.getOnValues().includes(value)) {
      throw new Error(`Invalid value "${value}" for checkbox "${this.name}"`);
    }

    // Set /V on field
    this.dict.set("V", PdfName.of(value));

    // Update /AS on each widget
    for (const widget of this.getWidgets()) {
      const widgetOnValue = widget.getOnValue();
      const state = widgetOnValue === value ? value : "Off";

      widget.setAppearanceState(state);
    }

    this.needsAppearanceUpdate = true;

    // Regenerate appearance immediately
    this.applyChange();
  }
}