pspdfkit/com.pspdfkit.document.search/SearchOptions

SearchOptions

class SearchOptions

Search options used when searching a loaded document for text.

See also

Types

Link copied to clipboard
class Builder
Builder for creating SearchOptions.

Properties

Link copied to clipboard
Link copied to clipboard
val maxSearchResults: Int
Maximum number of search results.
Link copied to clipboard
@NonNull
val priorityPages: List<Range>
Pages that should be searched first.
Link copied to clipboard
val searchAnnotations: Boolean
Indicates whether the search should be performed over annotation contents in addition to page text.
Link copied to clipboard
Link copied to clipboard
val snippetLength: Int
Number of preview characters extracted with every search result.
Link copied to clipboard
val UNLIMITED_SEARCH_RESULTS: Int = 2147483647
Use as argument for maxSearchResults to turn off search result limiting.