pspdfkit/com.pspdfkit.document.search/SearchOptions/Builder

Builder

class Builder

Builder for creating SearchOptions.

Constructors

Link copied to clipboard
constructor()
Creates a Builder with default configuration.

Functions

Link copied to clipboard
@NonNull
open fun build(): SearchOptions
Builds the search options.
Link copied to clipboard
@NonNull
open fun compareOptions(@NonNull compareOptions: Array<CompareOptions>): SearchOptions.Builder
@NonNull
open fun compareOptions(@NonNull compareOptions: EnumSet<CompareOptions>): SearchOptions.Builder
Sets CompareOptions to control various aspects of text search such as case sensitivity or whether regular expression search is enabled.
Link copied to clipboard
@NonNull
open fun maxSearchResults(maxSearchResults: Int): SearchOptions.Builder
Limits the maximum number of search results.
Link copied to clipboard
@NonNull
open fun priorityPages(@NonNull priorityPages: List<Range>): SearchOptions.Builder
Sets a list of page index ranges for pages that should be searched first.
@NonNull
open fun priorityPages(@NonNull priorityPages: List<Range>, searchOnlyInPriorityPages: Boolean): SearchOptions.Builder
Sets a list of page index ranges for pages that should be searched.
Link copied to clipboard
@NonNull
open fun searchAnnotations(searchAnnotationsTextEnabled: Boolean): SearchOptions.Builder
Enables/disables searching in annotations contents in addition to page text.
Link copied to clipboard
@NonNull
open fun snippetLength(snippetLength: Int): SearchOptions.Builder
Sets the maximum number of preview characters (i.e.