Guides

BOTA Configuration

The BOTA interface displays Bookmarks, Outline, and Annotations for a PDF document.

By configuring BOTA, you can control which sections are displayed and customize menu options within each section.

Configure BOTA through CPDFConfiguration.globalConfig.bota. If you do not provide this configuration, the SDK shows outline, bookmark, and annotations tabs by default.

Enable Specific Tabs

Use CPDFBotaConfig.tabs to configure the tabs to show:

CPDFConfiguration config = CPDFConfiguration(
  globalConfig: const CPDFGlobalConfig(
    bota: CPDFBotaConfig(
      tabs: [
        CPDFBotaTabs.outline,
        CPDFBotaTabs.annotations
      ]
    )
  )
);

Example:

Android	iOS

Configure Annotation Menus

BOTA supports both global menus and per-annotation menus:

CPDFConfiguration(
  globalConfig: const CPDFGlobalConfig(
    bota: CPDFBotaConfig(
      tabs: [
        CPDFBotaTabs.bookmark,
        CPDFBotaTabs.annotations,
      ],
      menus: CPDFBotaMenuConfig(
        annotations: CPDFBotaAnnotationMenuConfig(
          global: [
            CPDFBotaMenuItem(id: CPDFBotaAnnotGlobalMenu.importAnnotation),
            CPDFBotaMenuItem(id: CPDFBotaAnnotGlobalMenu.exportAnnotation),
            CPDFBotaMenuItem(id: CPDFBotaAnnotGlobalMenu.removeAllAnnotation),
          ],
          item: [
            CPDFBotaMenuItem(id: CPDFBotaAnnotItemMenu.reviewStatus, subMenus: [
              CPDFReviewState.accepted,
              CPDFReviewState.cancelled,
              CPDFReviewState.none,
            ]),
            CPDFBotaMenuItem(id: CPDFBotaAnnotItemMenu.more, subMenus: [
              CPDFBotaAnnotMoreMenu.delete
            ]),
          ]
        )
      )
    )
  )
)

Example:

Android	iOS

Annotation Global Menu Options

Option	Description
CPDFBotaAnnotGlobalMenu.importAnnotation	Import annotations
CPDFBotaAnnotGlobalMenu.exportAnnotation	Export annotations
CPDFBotaAnnotGlobalMenu.removeAllAnnotation	Remove all annotations
CPDFBotaAnnotGlobalMenu.removeAllReply	Remove all annotation replies

BOTA Configuration Fields

Field	Description
tabs	Tabs displayed in the BOTA panel. Supported values are outline, bookmark, and annotations.
menus.annotations.global	Global actions displayed in the annotations list toolbar.
menus.annotations.item	Actions displayed for each annotation item. Use subMenus to limit nested review or more-menu options.

Note: BOTA menu customization applies to the SDK-provided BOTA panel. If you build a custom BOTA screen with CPDFReaderWidgetController, handle those menu actions in your own UI.

Annotation Review Status Submenu

Option	Description
accepted	Accepted
rejected	Rejected
cancelled	Cancelled
completed	Completed
none	None

More Menu Options

Option	Description
addReply	Add annotation reply
viewReply	View annotation reply
delete	Delete annotation