DocumentSearchState class - universal_document_viewer library

DocumentSearchState class

A search in a document: the query, how many times it occurs and which occurrence is current.

Annotations

Constructors

DocumentSearchState({required String query, required int matchCount, required int currentMatch, bool isSearching = false, bool hasSearchableText = true}): A search for query with matchCount occurrences, currentMatch being the one shown.
const

currentMatch → int: Which occurrence is current, from 0; -1 when there are none.
final
hashCode → int: The hash code for this object.
no setteroverride
hasSearchableText → bool: False when the whole document was searched and had no text to search at all: a scanned PDF. A reason to say so instead of "No matches".
final
isActive → bool: Whether there's a query.
no setter
isSearching → bool: Whether the search is still running. PDF searches page by page in the background; the other formats finish at once.
final
matchCount → int: How many times query occurs (so far, while isSearching).
final
query → String: What is being searched for; empty when there's no search.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
override