Skip to content

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.

Enable Specific Tabs

Use CPDFBotaConfig.tabs to configure the tabs to show:

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

Example:

AndroidiOS
Android BOTA TabsiOS BOTA Tabs

Configure Annotation Menus

BOTA supports both global menus and per-annotation menus:

dart
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:

AndroidiOS
Android Annotation MenuiOS Annotation Menu

Annotation Global Menu Options

OptionDescription
CPDFBotaAnnotGlobalMenu.importAnnotationImport annotations
CPDFBotaAnnotGlobalMenu.exportAnnotationExport annotations
CPDFBotaAnnotGlobalMenu.removeAllAnnotationRemove all annotations
CPDFBotaAnnotGlobalMenu.removeAllReplyRemove all annotation replies

Annotation Review Status Submenu

OptionDescription
acceptedAccepted
rejectedRejected
cancelledCancelled
completedCompleted
noneNone

More Menu Options

OptionDescription
addReplyAdd annotation reply
viewReplyView annotation reply
deleteDelete annotation