WatermarkParams Class Documentation

class WatermarkParams

Namespace:datalogics_interface

Detailed Description

Watermark settings control the appearance of a watermark in a PDF.

Constructor & Destructor Documentation

WatermarkParams

WatermarkParams()

Initializes with rotation 0, full page range, opacity 1.0, scale 0.5, zOrderTop true, showOnPrint true, showOnScreen true, centered alignment, and the TryAnnotation draw option.

~WatermarkParams

~WatermarkParams()

Member Function Documentation

get_end_page

int get_end_page()

Returns:

int

Defaults to all pages.

get_horiz_value

float get_horiz_value()

Returns:

float

Watermark settings control the appearance of a watermark in a PDF.

get_opacity

float get_opacity()

Returns:

float

Watermark settings control the appearance of a watermark in a PDF.

get_page_spec

PageSpec get_page_spec()

Returns:

PageSpec

Get which pages the watermark targets.

get_rotation

float get_rotation()

Returns:

float

Watermark settings control the appearance of a watermark in a PDF.

get_scale

float get_scale()

Returns:

float

Watermark settings control the appearance of a watermark in a PDF.

get_show_on_print

bool get_show_on_print()

Returns:

bool

Watermark settings control the appearance of a watermark in a PDF.

get_show_on_screen

bool get_show_on_screen()

Returns:

bool

Watermark settings control the appearance of a watermark in a PDF.

get_start_page

int get_start_page()

Returns:

int

Defaults to all pages.

get_vert_value

float get_vert_value()

Returns:

float

Watermark settings control the appearance of a watermark in a PDF.

get_z_order_top

bool get_z_order_top()

Returns:

bool

Watermark settings control the appearance of a watermark in a PDF.

set_draw_option

void set_draw_option(WatermarkDrawOption option)

Parameters

option: WatermarkDrawOption

The watermark draw option.

Returns:

void

Controls whether the watermark is drawn as an annotation or form XObject.

set_end_page

void set_end_page(int page)

Parameters

page: int

Returns:

void

Defaults to all pages.

set_horiz_alignment

void set_horiz_alignment(HorizontalAlignment align)

Parameters

align: HorizontalAlignment

The horizontal alignment value.

Returns:

void

Set the horizontal alignment to be used when adding the watermark to a page.

set_horiz_value

void set_horiz_value(float value)

Parameters

value: float

Returns:

void

Watermark settings control the appearance of a watermark in a PDF.

set_opacity

void set_opacity(float opacity)

Parameters

opacity: float

Returns:

void

Watermark settings control the appearance of a watermark in a PDF.

set_page_spec

void set_page_spec(PageSpec spec)

Parameters

spec: PageSpec

Returns:

void

Set which pages the watermark targets.

set_rotation

void set_rotation(float degrees)

Parameters

degrees: float

Returns:

void

Watermark settings control the appearance of a watermark in a PDF.

set_scale

void set_scale(float scale)

Parameters

scale: float

Returns:

void

Watermark settings control the appearance of a watermark in a PDF.

set_show_on_print

void set_show_on_print(bool show)

Parameters

show: bool

Returns:

void

Watermark settings control the appearance of a watermark in a PDF.

set_show_on_screen

void set_show_on_screen(bool show)

Parameters

show: bool

Returns:

void

Watermark settings control the appearance of a watermark in a PDF.

set_start_page

void set_start_page(int page)

Parameters

page: int

Returns:

void

Defaults to all pages.

set_vert_alignment

void set_vert_alignment(VerticalAlignment align)

Parameters

align: VerticalAlignment

The vertical alignment value.

Returns:

void

Set the vertical alignment to be used when adding the watermark to a page.

set_vert_value

void set_vert_value(float value)

Parameters

value: float

Returns:

void

Watermark settings control the appearance of a watermark in a PDF.

set_z_order_top

void set_z_order_top(bool top)

Parameters

top: bool

Returns:

void

Watermark settings control the appearance of a watermark in a PDF.