FreeTextAnnotation Class

class FreeTextAnnotation : Annotation

Namespace:datalogics_interface

Inherits from:: Annotation

Detailed Description

The free text annotation allows a user to place text directly on a PDF page.

An ordinary text annotation appears in a pop up window, and is attached to an icon; it represents a note added to a PDF file, and can be opened for viewing, or closed. But a free text annotation always appears open on the page. A free text annotation can be included anywhere in a PDF file by specifying the location and the CallOutLine points.

Uses types

AnnotationFlags Color Form HorizontalAlignment Rect

Constructor & Destructor Documentation

FreeTextAnnotation(Page & page, const Rect & rect, const std::string & default_appearance)

Parameters

page: Page &: The page to which the FreeTextAnnotation is added.
rect: const Rect &: A rectangle specifying the annotation's bounds, specified in user space coordinates.
default_appearance: const std::string &: The default appearance string to be used in formatting the text.

Create a new FreeTextAnnotation at the end of a page's annotation array. To create a FreeTextAnnotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.

FreeTextAnnotation(Page & page, const Rect & rect, const std::string & default_appearance, int add_after)

Parameters

page: Page &: The page to which the FreeTextAnnotation is added.
rect: const Rect &: A rectangle specifying the annotation's bounds, specified in user space coordinates.
default_appearance: const std::string &: The default appearance string to be used in formatting the text.
add_after: int

~FreeTextAnnotation()

Member Function Documentation

void clear_interior_color()

Returns:

void

Clear the interior color.

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.

double get_annotation_feature_level()

Returns:

double

The 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.

std::vector< double > get_border_dash_pattern()

Returns:

std::vector< double >

An array defining a pattern of dashes and gaps to be used in drawing a dashed border (border style D).

The dash array is a series of numbers that specify the lengths of alternating dashes and gaps. Lengths must be nonnegative, and are expressed in user space units.

Default value is [3]

std::string get_border_style()

Returns:

std::string

The border style.

Can be one of: S - Solid D - Dashed. The dash pattern is specified as an array (see DashPattern) B - Beveled I - Inset U - Underline Other border styles may be defined in the future. Default is "S"

double get_border_style_width()

Returns:

double

The border width in points.

If this value is 0, no border is drawn. The default is 1.0.

Color get_color()

Returns:

Color

The annotation's color.

The color of the annotation.

std::string get_contents()

Returns:

std::string

The 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.

std::string get_default_appearance()

Returns:

std::string

The default appearance string to be used in formatting the text.

AnnotationFlags get_flags()

Returns:

AnnotationFlags

The annotation's flags.

The flags for the annotation.

std::string get_font_face()

Returns:

std::string

current Font face

Get Font face for the text

double get_font_size()

Returns:

double

current font size

Get font size for the text;

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.

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.

double get_opacity()

Returns:

double

The 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).

HorizontalAlignment get_quadding()

Returns:

HorizontalAlignment

A code specifiying the form of quadding (justification) to be used in displaying the annotation's text.

Rect get_rect()

Returns:

Rect

The annotation's bounding rectangle in user space coordinates.

The size and location of the annotation on its page.

std::string get_subtype()

Returns:

std::string

The subtype string (e.g. "Circle", "Square", "Line").

The annotation's subtype.

Color get_text_color()

Returns:

Color

color Freetext Annotation's text

The text color which used for drawing text

std::string get_title()

Returns:

std::string

The title string.

The title of the annotation.

bool has_rich_text_data()

Returns:

bool

true 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.

bool operator==(const Annotation & other)

Parameters

other: const Annotation &: The annotation to compare with this annotation.

Returns:

bool

true if the two annotations are equal.

Test annotations for equality (if they are the same annotation).

void set_annotation_feature_level(double level)

Parameters

level: double: The target PDF version level. Features requiring a higher version will be removed.

Returns:

void

Removes features not supported in the supplied version number.

void set_border_dash_pattern(const std::vector< double > & pattern)

Parameters

pattern: const std::vector< double > &: the border style dash pattern

Returns:

void

void set_border_style(const std::string & style)

Parameters

style: const std::string &: the border style

Returns:

void

void set_border_style_width(double width)

Parameters

width: double: the border style width

Returns:

void

void set_color(const Color & color)

Parameters

color: const Color &: The new color to set.

Returns:

void

The color of the annotation.

void set_contents(const std::string & contents)

Parameters

contents: const std::string &: The new text contents.

Returns:

void

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.

void set_default_appearance(const std::string & da)

Parameters

da: const std::string &

Returns:

void

The default appearance string to be used in formatting the text.

void set_flags(AnnotationFlags flags)

Parameters

flags: AnnotationFlags: The new annotation flags to set.

Returns:

void

The flags for the annotation.

void set_font_face(const std::string & name)

Parameters

name: const std::string &: font face for the text

Returns:

void

Set Font face for the text

void set_font_size(double size)

Parameters

size: double: font size for text

Returns:

void

Set font size for text

void set_interior_color(const Color & color)

Parameters

color: const Color &: The new interior fill color. Pass null to remove the interior color.

Returns:

void

The 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.

void set_normal_appearance(Form & form)

Parameters

form: Form &: The Form to use as the annotation's normal appearance.

Returns:

void

The normal appearance of the annotation, represented as a Form XObject.

void set_opacity(double opacity)

Parameters

opacity: double: The new opacity value to set.

Returns:

void

The constant opacity value used in painting a Markup annotation.

Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

void set_quadding(HorizontalAlignment quadding)

Parameters

quadding: HorizontalAlignment: a code specifiying the form of quadding (justification) to be used in displaying the annotation's text

Returns:

void

A code specifiying the form of quadding (justification) to be used in displaying the annotation's text.

void set_rect(const Rect & rect)

Parameters

rect: const Rect &: The new bounding rectangle in user space coordinates.

Returns:

void

The size and location of the annotation on its page.

void set_text_color(const Color & color)

Parameters

color: const Color &: the text color which used for drawing text

Returns:

void

The text color which used for drawing text

void set_title(const std::string & title)

Parameters

title: const std::string &: The new title string.

Returns:

void

The title of the annotation.

std::string to_string()

Returns:

std::string

A string describing this annotation, including its type and rectangle.

Returns a string representation of this annotation.

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.

const T * try_as(typename T )

Parameters

: typename T

Returns:

const T *

Const overload of try_as(). Returns a const pointer, or nullptr.