PdfMarkupAnnotation class final
A text markup annotation: highlight, underline, squiggly, or strikeout.
The subtype field distinguishes the four variants. quadPoints describes the exact region(s) of marked-up text; each element corresponds to one quadrilateral covering a line of text.
- Inheritance
-
- Object
- PdfAnnotation
- PdfMarkupAnnotation
Constructors
-
PdfMarkupAnnotation({required int pageIndex, required PdfAnnotationType subtype, required List<
PdfQuadPoints> quadPoints, String? markedText, String? contents, String? author, PdfRect? rect, PdfColor? color, PdfDate? modifiedDate, required int flags, PdfPopupAnnotation? popup}) -
Creates a PdfMarkupAnnotation.
const
Properties
-
The annotation author (
/Tdictionary entry), ornullif absent.finalinherited - color → PdfColor?
-
The annotation colour, or
nullif no colour entry is present.finalinherited - contents → String?
-
The annotation's
Contentsstring, ornullif absent.finalinherited - flags → int
-
Raw
FPDF_ANNOT_FLAG_*bitmask.finalinherited - hashCode → int
-
The hash code for this object.
no setteroverride
- markedText → String?
-
The text covered by this markup annotation, extracted from the page's text layer.
final
- modifiedDate → PdfDate?
-
The last-modified date (
/Mdictionary entry), ornullif absent.finalinherited - pageIndex → int
-
Zero-based index of the page this annotation belongs to.
finalinherited
- popup → PdfPopupAnnotation?
-
Inlined popup annotation data, or
nullif this annotation has no popup.finalinherited -
quadPoints
→ List<
PdfQuadPoints> -
Quad-point sets describing the marked-up text regions.
final
- rect → PdfRect?
-
The bounding rectangle in PDF page coordinates, or
nullif unavailable.finalinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- subtype → PdfAnnotationType
-
The markup subtype: PdfAnnotationType.highlight, PdfAnnotationType.underline,
PdfAnnotationType.squiggly, or PdfAnnotationType.strikeout.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override