PdfSearchFlag enum
Flags that control the text-search behaviour of PdfDocument.search.
Combine flags using a Set:
final matches = doc.search('example',
flags: {PdfSearchFlag.matchCase, PdfSearchFlag.matchWholeWord});
Flag values correspond to the PDFium FPDF_MATCHCASE,
FPDF_MATCHWHOLEWORD, and FPDF_CONSECUTIVE constants defined in
fpdf_text.h.
Values
- matchCase → const PdfSearchFlag
-
Case-sensitive matching (
FPDF_MATCHCASE = 0x00000001).When set, "Apple" does not match "apple". When absent the search is case-insensitive.
- matchWholeWord → const PdfSearchFlag
-
Whole-word matching (
FPDF_MATCHWHOLEWORD = 0x00000002).When set, "art" does not match the substring "art" inside "artist".
- consecutive → const PdfSearchFlag
-
Allow overlapping / consecutive matches (
FPDF_CONSECUTIVE = 0x00000004).When set, searching for "aa" in "aaa" produces two overlapping matches (at index 0 and index 1). When absent each match starts immediately after the previous match ends.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- index → int
-
A numeric identifier for the enumerated value.
no setterinherited
- name → String
-
Available on Enum, provided by the EnumName extension
The name of the enum value.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
-
values
→ const List<
PdfSearchFlag> - A constant List of the values in this enum, in order of their declaration.