Redaction Class Documentation

classRedaction : Annotation

Namespace:datalogics_interface

Inherits from:
Annotation

Detailed Description

A redaction occludes some part of a document.

Constructor & Destructor Documentation

Member Function Documentation

clear_interior_color

voidclear_interior_color()

Returns:

void

Clear the interior color.

generate_appearance

std::unique_ptr< Form >generate_appearance()

Returns:

A Form representing the visual appearance, or null if the appearance could not be generated.

The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.

get_align

HorizontalAlignmentget_align()

Returns:

Horiziontal Alignment

Get the horizontal alignment for the redaction text.

get_annotation_feature_level

doubleget_annotation_feature_level()

Returns:

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.

get_border_color

Colorget_border_color()

Returns:

Color used for the "normal" border.

Get the color used as the "normal" border.

get_color

Colorget_color()

Returns:

The annotation's color.

The color of the annotation.

get_contents

std::stringget_contents()

Returns:

The annotation's text contents.

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_draw_border

boolget_draw_border()

Returns:

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

get_fill_color

Colorget_fill_color()

Returns:

Color used to fill the "normal" appearance area.

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

get_fill_normal

boolget_fill_normal()

Returns:

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.

get_fill_opacity

doubleget_fill_opacity()

Returns:

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

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

get_fill_redacted

boolget_fill_redacted()

Returns:

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.

get_flags

AnnotationFlagsget_flags()

Returns:

The annotation's flags.

The flags for the annotation.

get_font_face

std::stringget_font_face()

Returns:

current Font face

Get Font face for the text

get_font_size

doubleget_font_size()

Returns:

current font size

Get font size for the text;

get_interior_color

std::unique_ptr< Color >get_interior_color()

Returns:

The interior fill color, or null if no interior color is set.

The color of the border itself can be retrieved from Annotation.Color.

get_internal_color

Colorget_internal_color()

Returns:

Color used for the replacement.

Get the color used as the replacement background.

get_normal_appearance

std::unique_ptr< Form >get_normal_appearance()

Returns:

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_note

std::stringget_note()

Returns:

Note text

Get the text string to be used as the Popup contents

get_opacity

doubleget_opacity()

Returns:

The opacity value for this annotation.

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

get_overlay_text

std::stringget_overlay_text()

Returns:

the overlay text of the redaction

Get the optional overlay text of the redaction.

get_page_no

intget_page_no()

Returns:

base zero page number

Get the page number where the redaction occurs.

get_quads

std::vector< Quad >get_quads()

Returns:

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.

get_rect

Rectget_rect()

Returns:

The annotation's bounding rectangle in user space coordinates.

The size and location of the annotation on its page.

get_repeat

boolget_repeat()

Returns:

repeat value

Get the repeat value

get_scale_to_fit

boolget_scale_to_fit()

Returns:

Scale To Fit value

Get the ScaleToFit value

get_subtype

std::stringget_subtype()

Returns:

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

The annotation's subtype.

get_text_color

Colorget_text_color()

Returns:

Color used for the overlay text.

Get the color used for the overlay text.

get_title

std::stringget_title()

Returns:

The title string.

The title of the annotation.

has_rich_text_data

boolhas_rich_text_data()

Returns:

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.

operator==

booloperator==(const Annotation &other)

Parameters

other: const Annotation &

The annotation to compare with this annotation.

Returns:

true if the two annotations are equal.

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

set_annotation_feature_level

voidset_annotation_feature_level(doublelevel)

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.

set_border_color

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

set_color

voidset_color(const Color &color)

Parameters

color: const Color &

The new color to set.

Returns:

void

The color of the annotation.

set_contents

voidset_contents(const std::string &contents)

Parameters

contents: const std::string &

The new text contents.

Returns:

void

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_draw_border

voidset_draw_border(boolvalue)

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

set_fill_color

voidset_fill_color(const Color &color, doubleopacity)

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.

set_fill_normal

voidset_fill_normal(boolvalue)

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

set_fill_redacted

voidset_fill_redacted(boolvalue)

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

set_font_face

voidset_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

set_font_size

voidset_font_size(doublesize)

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

set_interior_color

voidset_interior_color(const Color &color)

Parameters

color: const Color &

The new interior fill color. Pass null to remove the interior color.

Returns:

void

Only RGB colors are allowed.

The color of the border itself can be retrieved from Annotation.Color.

set_internal_color

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

set_normal_appearance

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

set_note

voidset_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

set_opacity

voidset_opacity(doubleopacity)

Parameters

opacity: double

The new opacity value to set.

Returns:

void

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

set_overlay_text

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

set_page_no

voidset_page_no(intpage_no)

Parameters

page_no: int

Base zero page number

Returns:

void

Sets the page number where the redaction occurs.

set_rect

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

set_repeat

voidset_repeat(boolvalue)

Parameters

value: bool

True will repeat fill string, false will display string only once.

Returns:

void

Set the repeat value

set_scale_to_fit

voidset_scale_to_fit(boolvalue)

Parameters

value: bool

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

Returns:

void

Set the ScaleToFit value

set_text_color

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

set_title

voidset_title(const std::string &title)

Parameters

title: const std::string &

The new title string.

Returns:

void

The title of the annotation.

to_string

std::stringto_string()

Returns:

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