# WatermarkParams Class

> Watermark settings control the appearance of a watermark in a PDF.

- Product: Adobe PDF Library 21
- Language: Java
- Version: APDFL21.0.0PlusP1e
- HTML page: https://docs.datalogics.com/apdfl21/Java/APDFL21.0.0PlusP1e/class/WatermarkParams
- Version index: https://docs.datalogics.com/apdfl21/Java/APDFL21.0.0PlusP1e/llms.txt

```java
class WatermarkParams
```

**Namespace:** `com::datalogics::PDFL`

## Description

Watermark settings control the appearance of a watermark in a PDF.

**Referenced by:** [`Document`](https://docs.datalogics.com/apdfl21/Java/APDFL21.0.0PlusP1e/class/Document.md)

**Uses types:** [`PageRange`](https://docs.datalogics.com/apdfl21/Java/APDFL21.0.0PlusP1e/class/PageRange.md)

## Constructors

### WatermarkParams

```java
com.datalogics.PDFL.WatermarkParams.WatermarkParams()
```

*constructor*

Construct default WatermarkParams. Initializes with rotation 0, full page range, opacity 1.0, scale 0.5, zOrderTop true, showOnPrint true, showOnScreen true, centered alignment, and the TryAnnotation draw option.

## Methods

### delete

```java
synchronized void com.datalogics.PDFL.WatermarkParams.delete(Boolean disposing)
```

*protected*

**Parameters**

- `disposing` (`Boolean`)

**Returns:** `synchronized void`

### delete

```java
synchronized void com.datalogics.PDFL.WatermarkParams.delete()
```

**Returns:** `synchronized void`

### finalize

```java
void com.datalogics.PDFL.WatermarkParams.finalize()
```

*protected*

**Returns:** `void`

### getFixedPrint

```java
boolean com.datalogics.PDFL.WatermarkParams.getFixedPrint()
```

**Returns:** `boolean`

A boolean specifying whether this watermark is a FixedPrint watermark. FixedPrint watermarks maintain their size and position regardless of the dimensions of the target media.

### getHorizAlign

```java
HorizontalAlignment com.datalogics.PDFL.WatermarkParams.getHorizAlign()
```

**Returns:** `HorizontalAlignment`

Get the horizontal alignment to be used when adding the watermark to a page. Defaults to center alignment.

### getHorizValue

```java
float com.datalogics.PDFL.WatermarkParams.getHorizValue()
```

**Returns:** `float`

The horizontal offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page width, with 1.0 meaning 100%. Otherwise this value is in user units.

### getOpacity

```java
float com.datalogics.PDFL.WatermarkParams.getOpacity()
```

**Returns:** `float`

The opacity to be used when adding the watermark, with 0.0 meaning fully transparent and 1.0 meaning fully opaque.

### getPercentageVals

```java
boolean com.datalogics.PDFL.WatermarkParams.getPercentageVals()
```

**Returns:** `boolean`

A boolean specifying the units of horizValue and vertValue. If it is true, horizValue and vertValue represent percentages of the page dimensions. Otherwise horizValue and vertValue are in user units.

### getRotation

```java
float com.datalogics.PDFL.WatermarkParams.getRotation()
```

**Returns:** `float`

The counter-clockwise rotation, in degrees, to be used when adding the watermark.

### getScale

```java
float com.datalogics.PDFL.WatermarkParams.getScale()
```

**Returns:** `float`

The scale factor to be used when adding the watermark, with 1.0 meaning 100%.

### getShowOnPrint

```java
boolean com.datalogics.PDFL.WatermarkParams.getShowOnPrint()
```

**Returns:** `boolean`

A boolean specifying whether the watermark should be printed.

### getShowOnScreen

```java
boolean com.datalogics.PDFL.WatermarkParams.getShowOnScreen()
```

**Returns:** `boolean`

A boolean specifying whether the watermark should be visible when viewing on screen.

### getTargetRange

```java
PageRange com.datalogics.PDFL.WatermarkParams.getTargetRange()
```

**Returns:** [`PageRange`](https://docs.datalogics.com/apdfl21/Java/APDFL21.0.0PlusP1e/class/PageRange.md)

The page range of the document to which the watermark should be added. Defaults to all pages.

### getVertAlign

```java
VerticalAlignment com.datalogics.PDFL.WatermarkParams.getVertAlign()
```

**Returns:** `VerticalAlignment`

Get the vertical alignment to be used when adding the watermark to a page. Defaults to center alignment.

### getVertValue

```java
float com.datalogics.PDFL.WatermarkParams.getVertValue()
```

**Returns:** `float`

The vertical offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page height, with 1.0 meaning 100%. Otherwise this value is in user units.

### getWatermarkDrawOption

```java
WatermarkDrawOption com.datalogics.PDFL.WatermarkParams.getWatermarkDrawOption()
```

**Returns:** `WatermarkDrawOption`

Get the draw option to be used when adding the watermark to a page. Controls whether the watermark is drawn as an annotation or form XObject.

### getZOrderTop

```java
boolean com.datalogics.PDFL.WatermarkParams.getZOrderTop()
```

**Returns:** `boolean`

A boolean specifying where in the page z-order the watermark should be added. If it is true, the watermark is added to the front of the page; otherwise, it is added as a background.

This parameter is ignored if fixedPrint is true, as all FixedPrint watermarks are added to the front of the page.

### setFixedPrint

```java
void com.datalogics.PDFL.WatermarkParams.setFixedPrint(boolean value)
```

**Parameters**

- `value` (`boolean`)

**Returns:** `void`

A boolean specifying whether this watermark is a FixedPrint watermark. FixedPrint watermarks maintain their size and position regardless of the dimensions of the target media.

### setHorizAlign

```java
void com.datalogics.PDFL.WatermarkParams.setHorizAlign(HorizontalAlignment h)
```

**Parameters**

- `h` (`HorizontalAlignment`): The horizontal alignment value.

**Returns:** `void`

Set the horizontal alignment to be used when adding the watermark to a page.

### setHorizValue

```java
void com.datalogics.PDFL.WatermarkParams.setHorizValue(float value)
```

**Parameters**

- `value` (`float`)

**Returns:** `void`

The horizontal offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page width, with 1.0 meaning 100%. Otherwise this value is in user units.

### setOpacity

```java
void com.datalogics.PDFL.WatermarkParams.setOpacity(float value)
```

**Parameters**

- `value` (`float`)

**Returns:** `void`

The opacity to be used when adding the watermark, with 0.0 meaning fully transparent and 1.0 meaning fully opaque.

### setPercentageVals

```java
void com.datalogics.PDFL.WatermarkParams.setPercentageVals(boolean value)
```

**Parameters**

- `value` (`boolean`)

**Returns:** `void`

A boolean specifying the units of horizValue and vertValue. If it is true, horizValue and vertValue represent percentages of the page dimensions. Otherwise horizValue and vertValue are in user units.

### setRotation

```java
void com.datalogics.PDFL.WatermarkParams.setRotation(float value)
```

**Parameters**

- `value` (`float`)

**Returns:** `void`

The counter-clockwise rotation, in degrees, to be used when adding the watermark.

### setScale

```java
void com.datalogics.PDFL.WatermarkParams.setScale(float value)
```

**Parameters**

- `value` (`float`)

**Returns:** `void`

The scale factor to be used when adding the watermark, with 1.0 meaning 100%.

### setShowOnPrint

```java
void com.datalogics.PDFL.WatermarkParams.setShowOnPrint(boolean value)
```

**Parameters**

- `value` (`boolean`)

**Returns:** `void`

A boolean specifying whether the watermark should be printed.

### setShowOnScreen

```java
void com.datalogics.PDFL.WatermarkParams.setShowOnScreen(boolean value)
```

**Parameters**

- `value` (`boolean`)

**Returns:** `void`

A boolean specifying whether the watermark should be visible when viewing on screen.

### setVertAlign

```java
void com.datalogics.PDFL.WatermarkParams.setVertAlign(VerticalAlignment v)
```

**Parameters**

- `v` (`VerticalAlignment`): The vertical alignment value.

**Returns:** `void`

Set the vertical alignment to be used when adding the watermark to a page.

### setVertValue

```java
void com.datalogics.PDFL.WatermarkParams.setVertValue(float value)
```

**Parameters**

- `value` (`float`)

**Returns:** `void`

The vertical offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page height, with 1.0 meaning 100%. Otherwise this value is in user units.

### setWatermarkDrawOption

```java
void com.datalogics.PDFL.WatermarkParams.setWatermarkDrawOption(WatermarkDrawOption drawoption)
```

**Parameters**

- `drawoption` (`WatermarkDrawOption`): The watermark draw option.

**Returns:** `void`

Set the draw option to be used when adding the watermark to a page. Controls whether the watermark is drawn as an annotation or form XObject.

### setZOrderTop

```java
void com.datalogics.PDFL.WatermarkParams.setZOrderTop(boolean value)
```

**Parameters**

- `value` (`boolean`)

**Returns:** `void`

A boolean specifying where in the page z-order the watermark should be added. If it is true, the watermark is added to the front of the page; otherwise, it is added as a background.

This parameter is ignored if fixedPrint is true, as all FixedPrint watermarks are added to the front of the page.