Redaction Class

class Redaction : Annotation

Namespace:datalogics_interface

Inherits from:: Annotation

Detailed Description

Associates an object with its location on a page of a PDF document.

A redaction occludes some part of a document.

Uses types

AnnotationFlags Color Form HorizontalAlignment Quad Rect

Constructor & Destructor Documentation

Redaction(Page & page, const std::vector< Quad > & regions)

Parameters

page: Page &: The page where the redaction is placed.
regions: const std::vector< Quad > &: Quadrilateral regions specifying the redaction bounds.

Create a new Redaction annotation with default properties.

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.

HorizontalAlignment get_align()

Returns:

HorizontalAlignment

Horiziontal Alignment

Get the horizontal alignment for the redaction text.

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.

Color get_border_color()

Returns:

Color

Color used for the "normal" border.

Get the color used as the "normal" border.

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.

bool get_draw_border()

Returns:

bool

boolean value of Draw Border Option If true, border will be drawn in Normal appearance in specified color, If false, no border will be drawn in Normal Appearance.

Get Draw Border option

This option will be true by default in the Brief Initializer, and the border drawn will be in the specified color. It will also be true by default in the Extended initializer, and will draw the border in the specified border color

Color get_fill_color()

Returns:

Color

Color used to fill the "normal" appearance area.

Get the color used to fill the "normal" appearance area.

bool get_fill_normal()

Returns:

bool

boolean value of Fill Normal Appearance Option If true, the Normal Appearance will show as filled with the fill color and opacity, If false, Normal Appearance areas will not be filled.

Get Fill Normal Appearance option

This option will be false by default in the Brief Initializer. It will be true by default in the Extended initializer, and will fill the area in the specified fill color and opacity.

double get_fill_opacity()

Returns:

double

Opacity applied to the fill color in "normal" appearance.

Get the opacity applied to the fill color in "normal" appearance.

bool get_fill_redacted()

Returns:

bool

boolean value of Fill redacted Appearance Option If true, the Redacted Appearance will show as filled with the specfied color. If false, Redacted Appearance areas will not be filled (They will be left white).

Get Fill Redacted Appearance option

This option will be true by default in the Brief Initializer, and will fill with the color specified It will be true by default in the Extended initializer, and will draw the border in the specified color.

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.

Color get_internal_color()

Returns:

Color

Color used for the replacement.

Get the color used as the replacement background.

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.

std::string get_note()

Returns:

std::string

Note text

Get the text string to be used as the Popup contents

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

std::string get_overlay_text()

Returns:

std::string

the overlay text of the redaction

Get the optional overlay text of the redaction.

int get_page_no()

Returns:

int

base zero page number

Get the page number where the redaction occurs.

std::vector< Quad > get_quads()

Returns:

std::vector< Quad >

A vector of CQuad objects for the redaction.

A list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.

Rect get_rect()

Returns:

Rect

The annotation's bounding rectangle in user space coordinates.

The size and location of the annotation on its page.

bool get_repeat()

Returns:

bool

repeat value

Get the repeat value

bool get_scale_to_fit()

Returns:

bool

Scale To Fit value

Get the ScaleToFit value

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 used for the overlay text.

Get the color used for the overlay 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_align(HorizontalAlignment align)

Parameters

align: HorizontalAlignment: desired Horiziontal alignment

Returns:

void

Sets the horizontal alignment for the redaction text.

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_color(const Color & color)

Parameters

color: const Color &: The color of the border when the annotation is displayed in the page prior to application of redactions.

Returns:

void

Set the color used as the "normal" border.

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_draw_border(bool value)

Parameters

value: bool: boolean value to set Draw Border Option If true, border will be drawn in Normal appearance in specified color, If false, no border will be drawn in Normal Appearance.

Returns:

void

Set Draw Border option

void set_fill_color(const Color & color, double opacity)

Parameters

color: const Color &: The color which will fill the annotation when it is viewed in the "normal" or pre-redacted appearance.
opacity: double: The amount of opacity to apply to the fill color. If this value is zero, not color will be seen. If it is 1.0, then the underlying content of the unredacted document will not be visible.

Returns:

void

Set the color used to fill the "normal" appearance.

void set_fill_normal(bool value)

Parameters

value: bool: boolean value to set Draw Border Option If true, the Normal Appearance will show as filled with the fill color and opacity, If false, Normal Appearance areas will not be filled.

Returns:

void

Set Fill Normal Appearance option

void set_fill_redacted(bool value)

Parameters

value: bool: boolean value to set Draw Border Option If true, the Redacted Appearance will show as filled with the specfied, If false, Redacted Appearance areas will not be filled (They will be left white).

Returns:

void

Set Fill Redacted Appearance option

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 &: UTF-8 name of font to use for type. if omitted, "Helvetica" will be used.

Returns:

void

Set Font face for the text

void set_font_size(double size)

Parameters

size: double: Size to draw overlay type at. if set to zero, 10.0 point type will be drawn.

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_internal_color(const Color & color)

Parameters

color: const Color &: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

Returns:

void

Set the color used as the replacement background.

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_note(const std::string & text)

Parameters

text: const std::string &: Contents to use on the popup comments box.

Returns:

void

Set the text string to be used as the Popup Contents

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_overlay_text(const std::string & text)

Parameters

text: const std::string &: UTF-8 text to be written over redaction.

Returns:

void

Set the optional overlay text of the redaction.

void set_page_no(int page_no)

Parameters

page_no: int: Base zero page number

Returns:

void

Sets the page number where the redaction occurs.

void set_quads(const std::vector< Quad > & quads)

Parameters

quads: const std::vector< Quad > &: std::vector of Quads

Returns:

void

A list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.

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_repeat(bool value)

Parameters

value: bool: True will repeat fill string, false will display string only once.

Returns:

void

Set the repeat value

void set_scale_to_fit(bool value)

Parameters

value: bool: True will scale text down to fit into area, false will not.

Returns:

void

Set the ScaleToFit value

void set_text_color(const Color & color)

Parameters

color: const Color &: The color of the text when the annotation is displayed as redacted, or when the redactions are applied.

Returns:

void

Set the color used for the overlay 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.