Skip to content
ComPDF
DemoFAQ

PDF Generation Template Editor

Open-source visual PDF generation engine with customizable templates and developer-friendly APIs.

View on GitHub
Guides

Forms

Use these callbacks and events to synchronize form property panels and observe form-field creation and selection.

Callback or eventEvent dataTrigger
onFormStyleDialogDismissedCallbackCPDFFormType typeThe form properties panel closes.
CPDFEvent.formFieldsCreatedCPDFWidgetA form field is created.
CPDFEvent.formFieldsSelectedCPDFWidgetA form field is selected.
CPDFEvent.formFieldsDeselectedCPDFWidget?A form field is deselected.
dart
void _onReaderCreated(CPDFReaderWidgetController controller) {
  controller.addEventListener(
    CPDFEvent.formFieldsCreated,
    (widget) => debugPrint('Created: $widget'),
  );
  controller.addEventListener(
    CPDFEvent.formFieldsSelected,
    (widget) => debugPrint('Selected: $widget'),
  );
  controller.addEventListener(
    CPDFEvent.formFieldsDeselected,
    (widget) => debugPrint('Deselected: $widget'),
  );
}

CPDFEvent currently covers creation and selection state. It does not report form updates and deletions, or save failures. Custom handling for form-field taps is covered in Custom Annotation Creation Workflows.