Skip to content
ComPDF
Guides

Search & Replace

ComPDFKit_Tools provides two search toolbars: the Search Toolbar in reading mode and the Search & Replace Toolbar in content editor mode.

Search Configuration

Configure search highlight styles via GlobalConfig's searchConfig:

json
{
  "global": {
    "searchConfig": {
      "searchHighlightColor": "#FFFF00",
      "currentSearchHighlightColor": "#FF8000"
    }
  }
}
FieldDescription
searchHighlightColorHighlight color for matched results
currentSearchHighlightColorHighlight color for the currently focused match

CSearchToolbar (Search Toolbar)

CSearchToolbar is the search toolbar for reading mode, located in the com.compdfkit.tools.viewer.pdfsearch package.

Features:

  • Full-text search by keyword
  • Navigate to previous/next result
  • Search result highlighting
  • Case-sensitive search support

Usage

The search toolbar can be triggered by:

  1. Toolbar button: Ensure toolbarRightItems contains "search"
  2. More menu: No additional configuration needed; triggered via the search button by default

CSearchReplaceToolbar (Search & Replace Toolbar)

CSearchReplaceToolbar is used in content editor mode and supports searching and replacing text content.

Features:

  • Search text
  • Replace matches one by one
  • Replace all
  • Navigate to previous/next result
ComponentDescription
CSearchToolbarReading mode search toolbar
CSearchReplaceToolbarContent editor mode search & replace toolbar
CSearchResultListFragmentSearch result list Fragment
CSearchResultListAdapterSearch result list adapter

Context Menu Configuration

In content editor mode, the search & replace context menu is configured via contextMenuConfig.contentEditorMode.searchReplace:

json
{
  "contextMenuConfig": {
    "contentEditorMode": {
      "searchReplace": [
        { "key": "replace" }
      ]
    }
  }
}