Method createTextField

src/api/pdf-form.ts:529–619

* Create a new text field. * * Creates a text field with an empty /Kids array. Use `page.drawField()` to * add widgets that place the field on pages. * * @param name - Field name (must be unique) * @param options - Text field options * @returns The created text field * @throw

(name: string, options: TextFieldOptions = {})

   * ```
   */
  createTextField(name: string, options: TextFieldOptions = {}): TextField {
    this.validateUniqueName(name);

    // Build field flags
    let flags = 0;

    if (options.multiline) {
      flags |= FieldFlags.MULTILINE;
    }

    if (options.password) {
      flags |= FieldFlags.PASSWORD;
    }

    if (options.comb && options.maxLength && options.maxLength > 0) {
      flags |= FieldFlags.COMB;
    }

    // Build default appearance string
    const da = this.buildDefaultAppearance(options.font, options.fontSize, options.color);

    // Create field dictionary with /Kids array (separate widget model)
    const fieldDict = PdfDict.of({
      FT: PdfName.of("Tx"),
      T: PdfString.fromString(name),
      Kids: new PdfArray([]),
    });

    if (flags !== 0) {
      fieldDict.set("Ff", PdfNumber.of(flags));
    }

    if (da) {
      fieldDict.set("DA", PdfString.fromString(da));
    }

    if (options.alignment !== undefined) {
      fieldDict.set("Q", PdfNumber.of(alignmentToQuadding(options.alignment)));
    }

    if (options.maxLength !== undefined && options.maxLength > 0) {
      fieldDict.set("MaxLen", PdfNumber.of(options.maxLength));
    }

    if (options.defaultValue !== undefined) {
      fieldDict.set("V", PdfString.fromString(options.defaultValue));
      fieldDict.set("DV", PdfString.fromString(options.defaultValue));
    }

    // Register font in form resources if embedded font provided
    if (options.font) {
      this.registerFontInFormResources(options.font);
    }

    // Register and add to form
    const fieldRef = this._ctx.registry.register(fieldDict);
    this._acroForm.addField(fieldRef);