com.aspose.words

Class Watermark

java.lang.Object

com.aspose.words.Watermark

public final class Watermark
extends java.lang.Object

Represents class to work with document watermark.

To learn more, visit the Working with Watermark documentation article.

Method Summary

Modifier and Type	Method and Description
int	getType() Gets the watermark type.
void	remove() Removes the watermark.
void	setImage(java.awt.image.BufferedImage image) Adds Image watermark into the document.
void	setImage(java.awt.image.BufferedImage image, ImageWatermarkOptions options) Adds Image watermark into the document.
void	setImage(java.lang.String imagePath, ImageWatermarkOptions options) Adds Image watermark into the document.
void	setText(java.lang.String text) Adds Text watermark into the document.
void	setText(java.lang.String text, TextWatermarkOptions options) Adds Text watermark into the document.

Methods inherited from class java.lang.Object

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

Method Detail

setText

public final void setText(java.lang.String text)
                   throws java.lang.Exception

Adds Text watermark into the document.

Parameters:

text - Text that is displayed as a watermark.

Throws:

java.lang.IllegalArgumentException - Throws when the text length is out of range or the text contains only whitespaces.

com.aspose.words.net.System.ArgumentNullException - Throws when the text is null.

java.lang.Exception

setText

public final void setText(java.lang.String text,
                          TextWatermarkOptions options)
                   throws java.lang.Exception

Adds Text watermark into the document.

Parameters:

text - Text that is displayed as a watermark.

options - Defines additional options for the text watermark.

Throws:

java.lang.IllegalArgumentException - Throws when the text length is out of range or the text contain only whitespaces.

com.aspose.words.net.System.ArgumentNullException - Throws when the text is null.

java.lang.Exception

setImage

public final void setImage(java.awt.image.BufferedImage image)
                    throws java.lang.Exception

Adds Image watermark into the document.

Parameters:

image - Image that is displayed as a watermark.

Throws:

com.aspose.words.net.System.ArgumentNullException - Throws when the image is null.

java.lang.Exception

setImage

public final void setImage(java.awt.image.BufferedImage image,
                           ImageWatermarkOptions options)
                    throws java.lang.Exception

Adds Image watermark into the document.

Parameters:

image - Image that is displayed as a watermark.

options - Defines additional options for the image watermark.

Throws:

com.aspose.words.net.System.ArgumentNullException - Throws when the image is null.

java.lang.Exception

setImage

public final void setImage(java.lang.String imagePath,
                           ImageWatermarkOptions options)
                    throws java.lang.Exception

Adds Image watermark into the document.

Parameters:

imagePath - Path to the image file that is displayed as a watermark.

options - Defines additional options for the image watermark.

Throws:

com.aspose.words.net.System.ArgumentNullException - Throws when the path is null.

java.lang.Exception

getType

public final int getType()

Gets the watermark type.

Returns:

The watermark type. The returned value is one of WatermarkType constants.

remove

public final void remove()

Removes the watermark.