WatermarkParams Class Documentation

classWatermarkParams

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

intget_end_page()

Returns:

int

Defaults to all pages.

get_horiz_value

floatget_horiz_value()

Returns:

float

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

get_opacity

floatget_opacity()

Returns:

float

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

get_page_spec

PageSpecget_page_spec()

Returns:

PageSpec

Get which pages the watermark targets.

get_rotation

floatget_rotation()

Returns:

float

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

get_scale

floatget_scale()

Returns:

float

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

get_show_on_print

boolget_show_on_print()

Returns:

bool

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

get_show_on_screen

boolget_show_on_screen()

Returns:

bool

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

get_start_page

intget_start_page()

Returns:

int

Defaults to all pages.

get_vert_value

floatget_vert_value()

Returns:

float

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

get_z_order_top

boolget_z_order_top()

Returns:

bool

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

set_draw_option

voidset_draw_option(WatermarkDrawOptionoption)

Parameters

option: WatermarkDrawOption

The watermark draw option.

Returns:

void

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

set_end_page

voidset_end_page(intpage)

Parameters

page: int

Returns:

void

Defaults to all pages.

set_horiz_alignment

voidset_horiz_alignment(HorizontalAlignmentalign)

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

voidset_horiz_value(floatvalue)

Parameters

value: float

Returns:

void

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

set_opacity

voidset_opacity(floatopacity)

Parameters

opacity: float

Returns:

void

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

set_page_spec

voidset_page_spec(PageSpecspec)

Parameters

spec: PageSpec

Returns:

void

Set which pages the watermark targets.

set_rotation

voidset_rotation(floatdegrees)

Parameters

degrees: float

Returns:

void

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

set_scale

voidset_scale(floatscale)

Parameters

scale: float

Returns:

void

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

set_show_on_print

voidset_show_on_print(boolshow)

Parameters

show: bool

Returns:

void

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

set_show_on_screen

voidset_show_on_screen(boolshow)

Parameters

show: bool

Returns:

void

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

set_start_page

voidset_start_page(intpage)

Parameters

page: int

Returns:

void

Defaults to all pages.

set_vert_alignment

voidset_vert_alignment(VerticalAlignmentalign)

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

voidset_vert_value(floatvalue)

Parameters

value: float

Returns:

void

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

set_z_order_top

voidset_z_order_top(booltop)

Parameters

top: bool

Returns:

void

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