com.aspose.words

Class ImageWatermarkOptions

java.lang.Object

com.aspose.words.ImageWatermarkOptions

public class ImageWatermarkOptions
extends java.lang.Object

Contains options that can be specified when adding a watermark with image.

Method Summary

Modifier and Type	Method and Description
double	getScale() Gets the scale factor expressed as a fraction of the image.
boolean	isWashout() Gets a boolean value which is responsible for washout effect of the watermark.
void	isWashout(boolean value) Sets a boolean value which is responsible for washout effect of the watermark.
void	setScale(double value) Sets the scale factor expressed as a fraction of the image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getScale

public double getScale()

Gets the scale factor expressed as a fraction of the image. The default value is 0 - auto.

Valid values range from 0 to 65.5 inclusive.

Auto scale means that the watermark will be scaled to its max width and max height relative to the page margins.

Returns:

The scale factor expressed as a fraction of the image.

Throws:

java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.

setScale

public void setScale(double value)

Sets the scale factor expressed as a fraction of the image. The default value is 0 - auto.

Valid values range from 0 to 65.5 inclusive.

Auto scale means that the watermark will be scaled to its max width and max height relative to the page margins.

Parameters:

value - The scale factor expressed as a fraction of the image.

Throws:

java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.

isWashout

public boolean isWashout()

Gets a boolean value which is responsible for washout effect of the watermark. The default value is True.

Returns:

A boolean value which is responsible for washout effect of the watermark.

isWashout

public void isWashout(boolean value)

Sets a boolean value which is responsible for washout effect of the watermark. The default value is True.

Parameters:

value - A boolean value which is responsible for washout effect of the watermark.