SignDocWatermark Class |
Namespace: de.softpro.signdocsdk
public sealed class SignDocWatermark : IDisposable
The SignDocWatermark type exposes the following members.
Name | Description | |
---|---|---|
SignDocWatermark | Constructor. | |
SignDocWatermark(SignDocWatermark) | Constructor. |
Name | Description | |
---|---|---|
clear | Reset all parameters to their default values. | |
Dispose | Releases all resources used by the SignDocWatermark | |
setFirstPage | Set the first page number.
The default value is 1.
| |
setFlags |
Set flags.
Initially, no flag is set.
| |
setFontName | Set the name of the font.
The font name can be the name of a standard font, the name of an
already embedded font, or the name of a font defined by a font
configuration file.
The default value is "Helvetica".
| |
setFontSize | Set the font size.
The default value is 24.
| |
setHorizontalPosition | Set the horizontal position of the watermark.
The default values are ha_center and 0.
The distance is measured from the left edge of the page to the
left edge of the watermark (ha_left), from the center of the page
to the center of the watermark (ha_center), or from the right
edge of the page to the right edge of the watermark.
For ha_left and ha_center, positive values push the watermark to
the right, for ha_right, positive values push the watermark to
the left.
| |
setJustification | Set the justification for multi-line text.
The default value is j_left.
If the text (see setText()) contains only one line (ie, no
newline characters), this parameter will be ignored.
| |
setLastPage | Set the last page number.
The default value is 0.
| |
setLocation | Set whether the watermark will appear behind the page or
on top of the page.
The default value is l_overlay.
| |
setOpacity | Set the opacity.
The default value is 1.0. Documents conforming to PDF/A-1 must
use an opacity of 1.0.
| |
setPageIncrement | Set the page number increment.
The default value is 1 (add watermark to all pages between
the first page and the last page)
| |
setRotation | Set the rotation.
The default value is 0.
| |
setScale | Disable scaling or set scaling relative to page.
The default value is 0.5.
| |
setText | Set the text to be used for the watermark.
The default value is empty.
The text can contain multiple lines, the newline character is
used to separate lines. If there are multiple lines, their
relative position is specified by setJustification().
Complex scripts are supported, see @ref
signdocshared_complex_scripts.By default, this function uses paragraph
direction LTR.Use setFlags() if you need to set a different
paragraph direction.
| |
setTextColor | Set the text color.
The default value is SignDocGrayColor(0) (black).
| |
setVerticalPosition | Set the vertical position of the watermark.
The default values are va_center and 0.
The distance is measured from the top edge of the page to the
top edge of the watermark (va_top), from the center of the page
to the center of the watermark (va_center), or from the bottom
edge of the page to the bottom edge of the watermark.
For va_bottom and va_center, positive values push the watermark
up, for va_top, positive values push the watermark down.
|