Table of Contents

Watermark Class

Definition

Namespace
GleamTech.DocumentUltimate
Assembly
GleamTech.DocumentUltimate.dll

Represents a set of watermark options used for document conversion.

public abstract class Watermark
Inheritance
Watermark
Derived

Properties

AnnotationMode

Gets or sets a value indicating if the watermark should be added as an annotation to a document page. Default is false.

InBackground will not work with annotation mode. Viewing and printing permissions for the annotation can be controlled by ScreenVisible and PrintVisible.

DistanceIsPercentage

Gets or sets a value indicating if to treat HorizontalDistance and VerticalDistance values as percentage. Default is false.

If true, HorizontalDistance is a percentage of the page width (e.g. 50 means 50% of the page width) and VerticalDistance is a percentage of the page height (e.g. 50 means 50% of the page height). If false, HorizontalDistance and VerticalDistance are measured in points.

Height

Gets or sets the height of the watermark; in points or in percentage if SizeIsPercentage is set to true (e.g. 50 means 50% of the page height). Default is 0.

If also Width is specified, the resulting height may be smaller than the given one to maintain the aspect ratio.

HorizontalAlignment

Gets or sets a value indicating how the watermark is horizontally aligned relative to a document page. Default is Left.
HorizontalDistance

Gets or sets the horizontal distance from left, right or center of document page; in points or in percentage if DistanceIsPercentage is set to true (e.g. 50 means 50% of the page width). Default is 0.
InBackground

Gets or sets a value indicating if the watermark should be added as a background layer to a document page. Default is false.

InBackground will not work when AnnotationMode is true.

Opacity

Gets or sets the opacity of the watermark. Default is 100.

Values are between 0 and 100. Value 0 is invisible, value 100 is fully visible.

PageRange

Gets or sets the range of page numbers to add the watermark to. Default is "all".

A string representation of number ranges (e.g. 1-5, 8, 11-13) or keywords (all, even, odd) can be directly assigned to this property.

PrintVisible

Gets or sets a value indicating if the annotation watermark should be displayed when printed. Default is true.

Note that this property is effective only when AnnotationMode is true.

Rotation

Gets or sets the rotation angle in degrees of the watermark. Default is 0.
ScreenVisible

Gets or sets a value indicating if the annotation watermark should be displayed on screen. Default is true.

Note that this property is effective only when AnnotationMode is true.

SizeIsPercentage

Gets or sets a value indicating if to treat Width and Height values as percentage. Default is false.

If true, Width is a percentage of the page width (e.g. 50 means 50% of the page width) and Height is a percentage of the page height (e.g. 50 means 50% of the page height). If false, Width and Height are measured in points.

VerticalAlignment

Gets or sets a value indicating how the watermark is vertically aligned relative to a document page. Default is Top.
VerticalDistance

Gets or sets the vertical distance from top, bottom or center of document page; in points or in percentage if DistanceIsPercentage is set to true (e.g. 50 means 50% of the page height). Default is 0.
Width

Gets or sets the width of the watermark; in points or in percentage if SizeIsPercentage is set to true (e.g. 50 means 50% of the page width). Default is 0.

If also Height is specified, the resulting width may be smaller than the given one to maintain the aspect ratio.