TextMarkupAnnotation Class Documentation
class TextMarkupAnnotation : AnnotationNamespace:datalogics_interface
- Inherits from:
Annotation
- Derived classes:
- HighlightAnnotation, UnderlineAnnotation
Detailed Description
Annotations that appears as highlighted content when added to a PDF file.
Text markup annotations appear as highlights, underlines, or strikeouts when added to a PDF document in a PDF Viewer. When the edited PDF file is opened the markups appear in a pop-up window containing the text of the associated note.
Uses types
Constructor & Destructor Documentation
~TextMarkupAnnotation
~TextMarkupAnnotation()Member Function Documentation
clear_interior_color
void clear_interior_color()Returns:
voidClear the interior color.
generate_appearance
std::unique_ptr< Form > generate_appearance()Returns:
std::unique_ptr< Form >A Form representing the visual appearance, or null if the appearance could not be generated.
Generate a new appearance stream with the current annotation properties.
The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.
get_annotated_text
std::string get_annotated_text(bool split_lines)Parameters
split_lines: boolIf true, text corresponding to each quadrilateral will be separated by CRLF characters. If false, text corresponding to each quadrilateral will be separated by spaces.
Returns:
std::stringThe text marked by the annotation.
The text that is marked by the annotation. Marked text is defined as text which falls within one or more of the quadrilaterals specified by the annotation's QuadPoints entry. If the annotation marks partial words, only those portions of the word that are bounded within the QuadPoints array will be returned. If the annotation marks partial characters, the characters that fall partially within the annotation bounds may not be returned.
get_annotation_feature_level
double get_annotation_feature_level()Returns:
doubleThe minimum PDF version level (e.g. 1.3, 1.4, or 1.5).
The minimum PDF version necessary to support the features used in this annotation.
get_color
Color get_color()Returns:
ColorThe annotation's color.
The color of the annotation.
get_contents
std::string get_contents()Returns:
std::stringThe annotation's text contents.
The text contents of the annotation.
The text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form.
get_flags
AnnotationFlags get_flags()Returns:
AnnotationFlagsThe annotation's flags.
The flags for the annotation.
get_interior_color
std::unique_ptr< Color > get_interior_color()Returns:
std::unique_ptr< Color >The interior fill color, or null if no interior color is set.
The interior color with which to fill the annotation's rectangle or circle.
The color of the border itself can be retrieved from Annotation.Color.
get_normal_appearance
std::unique_ptr< Form > get_normal_appearance()Returns:
std::unique_ptr< Form >A Form representing the annotation's normal appearance, or null if no normal appearance has been set.
The normal appearance of the annotation, represented as a Form XObject.
get_opacity
double get_opacity()Returns:
doubleThe opacity value for this annotation.
The constant opacity value used in painting a Markup annotation.
Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).
get_quads
std::vector< Quad > get_quads()Returns:
std::vector< Quad >A list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.
get_rect
Rect get_rect()Returns:
RectThe annotation's bounding rectangle in user space coordinates.
The size and location of the annotation on its page.
get_subtype
std::string get_subtype()Returns:
std::stringThe subtype string (e.g. "Circle", "Square", "Line").
The annotation's subtype.
get_title
std::string get_title()Returns:
std::stringThe title string.
The title of the annotation.
has_rich_text_data
bool has_rich_text_data()Returns:
booltrue if the annotation contains Rich Text String content.
Checks the annotation for Rich Text String content (PDFReference 1.7 Section 8.6.2). Annotations that contain Rich Text String content and do not have a normal appearance set will not be visible when rendering the page.
operator==
bool operator==(const Annotation & other)Parameters
other: const Annotation &The annotation to compare with this annotation.
Returns:
booltrue if the two annotations are equal.
Test annotations for equality (if they are the same annotation).
set_annotation_feature_level
void set_annotation_feature_level(double level)Parameters
level: doubleThe target PDF version level. Features requiring a higher version will be removed.
Returns:
voidRemoves features not supported in the supplied version number.
set_color
void set_color(const Color & color)Parameters
color: const Color &The new color to set.
Returns:
voidThe color of the annotation.
set_contents
void set_contents(const std::string & contents)Parameters
contents: const std::string &The new text contents.
Returns:
voidThe text contents of the annotation.
The text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form.
set_flags
void set_flags(AnnotationFlags flags)Parameters
flags: AnnotationFlagsThe new annotation flags to set.
Returns:
voidThe flags for the annotation.
set_interior_color
void set_interior_color(const Color & color)Parameters
color: const Color &The new interior fill color. Pass null to remove the interior color.
Returns:
voidThe interior color with which to fill the annotation's rectangle or circle.
Only RGB colors are allowed.
The color of the border itself can be retrieved from Annotation.Color.
set_normal_appearance
void set_normal_appearance(Form & form)Parameters
form: Form &The Form to use as the annotation's normal appearance.
Returns:
voidThe normal appearance of the annotation, represented as a Form XObject.
set_opacity
void set_opacity(double opacity)Parameters
opacity: doubleThe new opacity value to set.
Returns:
voidThe constant opacity value used in painting a Markup annotation.
Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).
set_quads
void set_quads(const std::vector< Quad > & quads)Parameters
quads: const std::vector< Quad > &a list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation
Returns:
voidA list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.
set_rect
void set_rect(const Rect & rect)Parameters
rect: const Rect &The new bounding rectangle in user space coordinates.
Returns:
voidThe size and location of the annotation on its page.
set_title
void set_title(const std::string & title)Parameters
title: const std::string &The new title string.
Returns:
voidThe title of the annotation.
to_string
std::string to_string()Returns:
std::stringA string describing this annotation, including its type and rectangle.
Returns a string representation of this annotation.
try_as
T * try_as(typename T )Parameters
: typename T
Returns:
T *Attempt to downcast this annotation to a derived type. Returns a pointer to the derived type, or nullptr if the type doesn't match.
try_as
const T * try_as(typename T )Parameters
: typename T
Returns:
const T *Const overload of try_as(). Returns a const pointer, or nullptr.