Watermark Class

Represents a set of watermark options used for document conversion.

Definition

Namespace: GleamTech.DocumentUltimate
Assembly: GleamTech.DocumentUltimate (in GleamTech.DocumentUltimate.dll) Version: 6.9.7
C#
public abstract class Watermark
Inheritance
Object    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. Note that enabling this property is currently not supported for DocumentViewer but it can be enabled when generating PDF documents directly via DocumentConverter.
DistanceIsPercentage Gets or sets a value indicating how to handle HorizontalDistance and VerticalDistance values. If true, HorizontalDistance is a percentage of the page width (e.g. 50 is 50% of the page width) and VerticalDistance is a percentage of the page height (e.g. 50 is 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 (e.g. 50 is 50% of the page height) if SizeIsPercentage is set to true. If also Width is specified, the resulting height may be smaller than the given one to maintain the aspect ratio. For text watermaks, only percentage values are accepted after setting SizeIsPercentage to true.
HorizontalAlignmentGets or sets a value indicating how the watermark is horizontally aligned relative to a document page.
HorizontalDistance Gets or sets the horizontal distance from left, right or center of document page; in points or in percentage (e.g. 50 is 50% of the page width) if DistanceIsPercentage is set to true.
InBackground Gets or sets a value indicating if the watermark should be added as a background layer to a document page. Default is false.
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 watermark should be displayed when printed. Default is true. Note that disabling this property is currently not supported for DocumentViewer but it can be disabled when generating PDF documents directly via DocumentConverter.
RotationGets or sets the rotation angle in degrees of the watermark.
ScreenVisible Gets or sets a value indicating if the watermark should be displayed on screen. Default is true. Note that disabling this property is currently not supported for DocumentViewer but it can be disabled when generating PDF documents directly via DocumentConverter.
SizeIsPercentage Gets or sets a value indicating how to handle Width and Height values. If true, Width is a percentage of the page width (e.g. 50 is 50% of the page width) and Height is a percentage of the page height (e.g. 50 is 50% of the page height). If false, Width and Height are measured in points.
VerticalAlignmentGets or sets a value indicating how the watermark is vertically aligned relative to a document page.
VerticalDistance Gets or sets the vertical distance from top, bottom or center of document page; in points or in percentage (e.g. 50 is 50% of the page height) if DistanceIsPercentage is set to true.
Width Gets or sets the width of the watermark; in points or in percentage (e.g. 50 is 50% of the page width) if SizeIsPercentage is set to true. If also Height is specified, the resulting width may be smaller than the given one to maintain the aspect ratio. For text watermaks, only percentage values are accepted after setting SizeIsPercentage to true.

See Also