Skip to content

Forms Toolbar

The form toolbar in ComPDFKit can be flexibly configured to enable form types and tools. This section explains how to customize the form toolbar.

Default Form ToolBar

The default form toolbar contains the following form types and tools:

AndroidiOS

Customizing the Toolbar Buttons

You can enable or hide specific editing types by setting the availableTypes property in the formsConfig object. The following example demonstrates how to adjust the form types to only enable text fields and list boxes.

dart
CPDFConfiguration configuration = CPDFConfiguration(
  formsConfig: const CPDFFormsConfig(availableTypes: [
    CPDFFormType.textField,
    CPDFFormType.listBox
  ],availableTools: [
    CPDFFormConfigTool.undo,
    CPDFFormConfigTool.redo
  ]));

// CPDFReaderWidget Sample
Scaffold(
  resizeToAvoidBottomInset: false,
  appBar: AppBar(),
  body: CPDFReaderWidget(
    document: documentPath,
    configuration: configuration,
    onCreated: (controller) {},
  ));

// ComPDFKit.openDocument Sample
ComPDFKit.openDocument(documentPath, '', configuration)

The customized toolbar will look like what’s shown below.

AndroidiOS

Available Toolbar Customization Options

Type
CPDFFormType.textField
CPDFFormType.checkBox
CPDFFormType.radioButton
CPDFFormType.listBox
CPDFFormType.comboBox
CPDFFormType.signaturesFields
CPDFFormType.pushButton

Note: Please refer to CPDFFormType for the relevant options.

Available Toolbar Tool Customization Options

ToolDescription
SETTINGSet button, corresponding to open the selected annotation, text or picture property panel.
UNDOUndo annotation, content editing, form operations.
REDORedo an undone action

Note: Please refer to CPDFFormConfigTool for the relevant options.