WatermarkParams Class

class WatermarkParams : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

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

Referenced by

Document

Uses types

HorizontalAlignment PageRange VerticalAlignment WatermarkDrawOption

Constructor & Destructor Documentation

WatermarkParams()

Construct default 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.

Property Documentation

bool FixedPrint[get, set]

A boolean specifying whether this watermark is a FixedPrint watermark. FixedPrint watermarks maintain their size and position regardless of the dimensions of the target media.

HorizontalAlignment HorizAlign[get, set]

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

Defaults to center alignment.

float HorizValue[get, set]

The horizontal offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page width, with 1.0 meaning 100%. Otherwise this value is in user units.

float Opacity[get, set]

The opacity to be used when adding the watermark, with 0.0 meaning fully transparent and 1.0 meaning fully opaque.

bool PercentageVals[get, set]

A boolean specifying the units of horizValue and vertValue. If it is true, horizValue and vertValue represent percentages of the page dimensions. Otherwise horizValue and vertValue are in user units.

float Rotation[get, set]

The counter-clockwise rotation, in degrees, to be used when adding the watermark.

float Scale[get, set]

The scale factor to be used when adding the watermark, with 1.0 meaning 100%.

bool ShowOnPrint[get, set]

A boolean specifying whether the watermark should be printed.

bool ShowOnScreen[get, set]

A boolean specifying whether the watermark should be visible when viewing on screen.

PageRange TargetRange[get]

The page range of the document to which the watermark should be added.

Defaults to all pages.

VerticalAlignment VertAlign[get, set]

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

Defaults to center alignment.

float VertValue[get, set]

The vertical offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page height, with 1.0 meaning 100%. Otherwise this value is in user units.

WatermarkDrawOption WatermarkDrawOption[get, set]

Get the draw option to be used when adding the watermark to a page.

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

bool ZOrderTop[get, set]

A boolean specifying where in the page z-order the watermark should be added. If it is true, the watermark is added to the front of the page; otherwise, it is added as a background.

This parameter is ignored if fixedPrint is true, as all FixedPrint watermarks are added to the front of the page.

Member Function Documentation

void Dispose()

Returns:

void