Skip to content
DemoAPI 参考文档FAQ

PDF 生成模板编辑器

开源可视化 PDF 生成引擎,支持自定义模板,并提供面向开发者的 API,灵活构建文档生成流程。

查看 GitHub
Guides

表单

使用以下回调和事件同步表单属性面板,并监听表单字段的创建和选中状态。

表单 API

回调或事件事件数据触发时机
onFormStyleDialogDismissed{ type }表单属性面板关闭。
CPDFEvent.FORM_FIELDS_CREATEDCPDFWidget创建表单字段。
CPDFEvent.FORM_FIELDS_SELECTEDCPDFWidget选中表单字段。
CPDFEvent.FORM_FIELDS_DESELECTEDCPDFWidget | null取消选中表单字段。

表单字段 Deselected 事件的 TypeScript 类型允许 null,访问字段前应先判空。

tsx
const onFormFieldCreated = (widget: CPDFWidget) => {
  console.log("Created form field:", widget.type);
};

pdfReaderRef.current?.addEventListener(
  CPDFEvent.FORM_FIELDS_CREATED,
  onFormFieldCreated
);

这些事件不提供表单更新、删除或保存失败事件。

监听器生命周期处理参见注释。表单字段自定义操作参见自定义注释创建流程