RenderingWatermark

RenderingWatermark class

Watermark for rendering.

class RenderingWatermark;

Constructors

Name	Description
constructor(number[])	Creates instance of image watermark.
constructor(string, RenderingFont)	Creates instance of text watermark.

Methods

Method	Description
getRotation()	Gets or sets roation of the watermark in degrees.
setRotation(number)	Gets or sets roation of the watermark in degrees.
getScaleToPagePercent()	Gets or sets scale relative to target page in percent.
setScaleToPagePercent(number)	Gets or sets scale relative to target page in percent.
getOpacity()	Gets or sets opacity of the watermark in range [0, 1].
setOpacity(number)	Gets or sets opacity of the watermark in range [0, 1].
isBackground()	Indicates whether the watermark is placed behind page contents.
setIsBackground(boolean)	Indicates whether the watermark is placed behind page contents.
getText()	Gets text of the watermark.
getFont()	Gets font of the watermark.
getImage()	Gets image of the watermark.
getHAlignment()	Gets or sets horizontal alignment of the watermark to the page.
setHAlignment(TextAlignmentType)	Gets or sets horizontal alignment of the watermark to the page.
getVAlignment()	Gets or sets vertical alignment of the watermark to the page.
setVAlignment(TextAlignmentType)	Gets or sets vertical alignment of the watermark to the page.
getOffsetX()	Gets or sets offset value to HAlignment
setOffsetX(number)	Gets or sets offset value to HAlignment
getOffsetY()	Gets or sets offset value to VAlignment
setOffsetY(number)	Gets or sets offset value to VAlignment
isNull()	Checks whether the implementation object is null.

constructor(number[])

Creates instance of image watermark.

constructor(imageData: number[]);

Parameters:

Parameter	Type	Description
imageData	number[]

constructor(string, RenderingFont)

Creates instance of text watermark.

constructor(text: string, renderingFont: RenderingFont);

Parameters:

Parameter	Type	Description
text	string	watermark text
renderingFont	RenderingFont	watermark font

getRotation()

Gets or sets roation of the watermark in degrees.

getRotation() : number;

setRotation(number)

Gets or sets roation of the watermark in degrees.

setRotation(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getScaleToPagePercent()

Gets or sets scale relative to target page in percent.

getScaleToPagePercent() : number;

setScaleToPagePercent(number)

Gets or sets scale relative to target page in percent.

setScaleToPagePercent(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getOpacity()

Gets or sets opacity of the watermark in range [0, 1].

getOpacity() : number;

setOpacity(number)

Gets or sets opacity of the watermark in range [0, 1].

setOpacity(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isBackground()

Indicates whether the watermark is placed behind page contents.

isBackground() : boolean;

setIsBackground(boolean)

Indicates whether the watermark is placed behind page contents.

setIsBackground(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getText()

Gets text of the watermark.

getText() : string;

getFont()

Gets font of the watermark.

getFont() : RenderingFont;

Returns

RenderingFont

getImage()

Gets image of the watermark.

getImage() : number[];

Returns

number[]

getHAlignment()

Gets or sets horizontal alignment of the watermark to the page.

getHAlignment() : TextAlignmentType;

Returns

TextAlignmentType

Remarks

Only Left, Center, Right is valid. Default is Left.

setHAlignment(TextAlignmentType)

Gets or sets horizontal alignment of the watermark to the page.

setHAlignment(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

Remarks

Only Left, Center, Right is valid. Default is Left.

getVAlignment()

Gets or sets vertical alignment of the watermark to the page.

getVAlignment() : TextAlignmentType;

Returns

TextAlignmentType

Remarks

Only Top, Center, Bottom is valid. Default is Top.

setVAlignment(TextAlignmentType)

Gets or sets vertical alignment of the watermark to the page.

setVAlignment(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

Remarks

Only Top, Center, Bottom is valid. Default is Top.

getOffsetX()

Gets or sets offset value to HAlignment

getOffsetX() : number;

setOffsetX(number)

Gets or sets offset value to HAlignment

setOffsetX(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getOffsetY()

Gets or sets offset value to VAlignment

getOffsetY() : number;

setOffsetY(number)

Gets or sets offset value to VAlignment

setOffsetY(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;