Watermark (GroupDocs.Watermark (26.4) API Reference)

java.lang.Object
- com.groupdocs.watermark.Watermark

Direct Known Subclasses:

ImageWatermark, TextWatermark
```
public abstract class Watermark
extends Object
```
Represents a watermark to be added to a document.
Learn more
- More details about watermark properties: Adding text watermarks.
- More advanced watermarking topics: Adding watermarks

Constructor Summary

Constructors
Constructor and Description

Watermark()

Constructors
Constructor and Description
`Watermark()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`copyPropertiesValues(Watermark source, Watermark destination)`
`abstract WatermarkGeometry`	`createGeometry(ContentPartGeometry parent)`
`abstract Watermark`	`deepClone()`
`boolean`	`getConsiderParentMargins()` Gets a value indicating whether the watermark size and coordinates are calculated considering parent margins.
`double`	`getHeight()` Gets the desired height of this `Watermark`.
`int`	`getHorizontalAlignment()` Gets the horizontal alignment of this `Watermark`.
`Margins`	`getMargins()` Gets the margin settings of this `Watermark`.
`double`	`getOpacity()` Gets or sets the opacity of this `Watermark`.
`PagesSetup`	`getPagesSetup()` Gets the pages setup settings of this `Watermark`.
`double`	`getRotateAngle()` Gets the rotate angle of this `Watermark` in degrees.
`double`	`getScaleFactor()` Gets a value that defines how watermark size depends on parent size.
`abstract SizeD`	`getSize()`
`int`	`getSizingType()` Gets a value specifying a way watermark should be sized.
`TileOptions`	`getTileOptions()`
`double`	`getTransparency()`
`int`	`getVerticalAlignment()` Gets the vertical alignment of this `Watermark`.
`double`	`getWidth()` Gets the desired width of this `Watermark`.
`double`	`getX()` Gets the x-coordinate of this `Watermark`.
`double`	`getY()` Gets the y-coordinate of this `Watermark`.
`boolean`	`hasSameValues(Watermark watermark)`
`boolean`	`isBackground()` Gets a value indicating whether the watermark should be placed at background.
`abstract boolean`	`isImageWatermark()`
`abstract boolean`	`isTextWatermark()`
`void`	`setBackground(boolean value)` Sets a value indicating whether the watermark should be placed at background.
`void`	`setConsiderParentMargins(boolean value)` Sets a value indicating whether the watermark size and coordinates are calculated considering parent margins.
`void`	`setHeight(double value)` Sets the desired height of this `Watermark`.
`void`	`setHorizontalAlignment(int value)` Sets the horizontal alignment of this `Watermark`.
`void`	`setMargins(Margins value)` Sets the margin settings of this `Watermark`.
`void`	`setOpacity(double value)` Gets or sets the opacity of this `Watermark`.
`void`	`setPagesSetup(PagesSetup value)` Sets the pages setup settings of this `Watermark`.
`void`	`setRotateAngle(double value)` Sets the rotate angle of this `Watermark` in degrees.
`void`	`setScaleFactor(double value)` Sets a value that defines how watermark size depends on parent size.
`void`	`setSizingType(int value)` Sets a value specifying a way watermark should be sized.
`void`	`setTileOptions(TileOptions tileOptions)`
`void`	`setVerticalAlignment(int value)` Sets the vertical alignment of this `Watermark`.
`void`	`setWidth(double value)` Sets the desired width of this `Watermark`.
`void`	`setX(double value)` Sets the x-coordinate of this `Watermark`.
`void`	`setY(double value)` Sets the y-coordinate of this `Watermark`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Watermark
```
public Watermark()
```
- Method Detail
  - copyPropertiesValues
```
public static void copyPropertiesValues(Watermark source,
                                        Watermark destination)
```
  - createGeometry
```
public abstract WatermarkGeometry createGeometry(ContentPartGeometry parent)
```
  - deepClone
```
public abstract Watermark deepClone()
```
  - getConsiderParentMargins
```
public final boolean getConsiderParentMargins()
```
    Gets a value indicating whether the watermark size and coordinates are calculated considering parent margins.
    
    Returns:
    
    If the value is true, watermark size and coordinates are calculated considering parent margins. By default, the value is false, parent margins are ignored.
  - getHeight
```
public final double getHeight()
```
    Gets the desired height of this Watermark.
    
    Returns:
    
    The desired height of this Watermark.
  - getHorizontalAlignment
```
public final int getHorizontalAlignment()
```
    Gets the horizontal alignment of this Watermark.
    Default value is HorizontalAlignment.None.
    
    Returns:
    
    The HorizontalAlignment of this Watermark.
  - getMargins
```
public final Margins getMargins()
```
    Gets the margin settings of this Watermark.
    
    Returns:
    
    The margin settings of this Watermark.
  - getOpacity
```
public final double getOpacity()
```
    Gets or sets the opacity of this Watermark.
    The value of opacity should be between 0 and 1. The default value is 1.
    
    Returns:
    
    The opacity of this Watermark.
  - getPagesSetup
```
public final PagesSetup getPagesSetup()
```
    Gets the pages setup settings of this Watermark.
    
    Returns:
    
    The pages setup settings of this Watermark.
  - getRotateAngle
```
public final double getRotateAngle()
```
    Gets the rotate angle of this Watermark in degrees.
    
    Returns:
    
    The rotate angle of this Watermark in degrees.
  - getScaleFactor
```
public final double getScaleFactor()
```
    Gets a value that defines how watermark size depends on parent size.
    The value must be between 0 and 1.
    
    Returns:
    
    The scale factor of this Watermark.
  - getSize
```
public abstract SizeD getSize()
```
  - getSizingType
```
public final int getSizingType()
```
    Gets a value specifying a way watermark should be sized.
    
    Returns:
    
    The sizing type.
  - getTileOptions
```
public TileOptions getTileOptions()
```
  - getTransparency
```
public final double getTransparency()
```
  - getVerticalAlignment
```
public final int getVerticalAlignment()
```
    Gets the vertical alignment of this Watermark.
    Default value is VerticalAlignment.None.
    
    Returns:
    
    The VerticalAlignment of this Watermark.
  - getWidth
```
public final double getWidth()
```
    Gets the desired width of this Watermark.
    
    Returns:
    
    The desired width of this Watermark.
  - getX
```
public final double getX()
```
    Gets the x-coordinate of this Watermark.
    
    Returns:
    
    The x-coordinate of this Watermark.
  - getY
```
public final double getY()
```
    Gets the y-coordinate of this Watermark.
    
    Returns:
    
    The y-coordinate of this Watermark.
  - hasSameValues
```
public boolean hasSameValues(Watermark watermark)
```
  - isBackground
```
public final boolean isBackground()
```
    Gets a value indicating whether the watermark should be placed at background.
    
    Returns:
    
    If the value is true, the watermark will be placed at the bottom. By default, the value is false, the watermark will be placed at the top.
  - isImageWatermark
```
public abstract boolean isImageWatermark()
```
  - isTextWatermark
```
public abstract boolean isTextWatermark()
```
  - setBackground
```
public final void setBackground(boolean value)
```
    Sets a value indicating whether the watermark should be placed at background.
    
    Parameters:
    
    value - If the value is true, the watermark will be placed at the bottom. By default, the value is false, the watermark will be placed at the top.
  - setConsiderParentMargins
```
public final void setConsiderParentMargins(boolean value)
```
    Sets a value indicating whether the watermark size and coordinates are calculated considering parent margins.
    
    Parameters:
    
    value - If the value is true, watermark size and coordinates are calculated considering parent margins. By default, the value is false, parent margins are ignored.
  - setHeight
```
public final void setHeight(double value)
```
    Sets the desired height of this Watermark.
    Setting this property will also change the value of getSizingType() property to SizingType.Absolute.
    
    Parameters:
    
    value - The desired height of this Watermark.
  - setHorizontalAlignment
```
public final void setHorizontalAlignment(int value)
```
    Sets the horizontal alignment of this Watermark.
    Default value is HorizontalAlignment.None.
    
    Parameters:
    
    value - The HorizontalAlignment of this Watermark.
  - setMargins
```
public final void setMargins(Margins value)
```
    Sets the margin settings of this Watermark.
    
    Parameters:
    
    value - The margin settings of this Watermark.
  - setOpacity
```
public final void setOpacity(double value)
```
    Gets or sets the opacity of this Watermark.
    The value of opacity should be between 0 and 1. The default value is 1.
    
    Parameters:
    
    value - The opacity of this Watermark.
  - setPagesSetup
```
public final void setPagesSetup(PagesSetup value)
```
    Sets the pages setup settings of this Watermark.
    
    Parameters:
    
    value - The pages setup settings of this Watermark.
  - setRotateAngle
```
public final void setRotateAngle(double value)
```
    Sets the rotate angle of this Watermark in degrees.
    
    Parameters:
    
    value - The rotate angle of this Watermark in degrees.
  - setScaleFactor
```
public final void setScaleFactor(double value)
```
    Sets a value that defines how watermark size depends on parent size.
    The value must be between 0 and 1.
    
    Parameters:
    
    value - The scale factor of this Watermark.
  - setSizingType
```
public final void setSizingType(int value)
```
    Sets a value specifying a way watermark should be sized.
    
    Parameters:
    
    value - The sizing type.
  - setTileOptions
```
public void setTileOptions(TileOptions tileOptions)
```
  - setVerticalAlignment
```
public final void setVerticalAlignment(int value)
```
    Sets the vertical alignment of this Watermark.
    Default value is VerticalAlignment.None.
    
    Parameters:
    
    value - The VerticalAlignment of this Watermark.
  - setWidth
```
public final void setWidth(double value)
```
    Sets the desired width of this Watermark.
    Setting this property will also change the value of getSizingType() property to SizingType.Absolute.
    
    Parameters:
    
    value - The desired width of this Watermark.
  - setX
```
public final void setX(double value)
```
    Sets the x-coordinate of this Watermark.
    
    Parameters:
    
    value - The x-coordinate of this Watermark.
  - setY
```
public final void setY(double value)
```
    Sets the y-coordinate of this Watermark.
    
    Parameters:
    
    value - The y-coordinate of this Watermark.

Class Watermark

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Watermark

Method Detail

copyPropertiesValues

createGeometry

deepClone

getConsiderParentMargins

getHeight

getHorizontalAlignment

getMargins

getOpacity

getPagesSetup

getRotateAngle

getScaleFactor

getSize

getSizingType

getTileOptions

getTransparency

getVerticalAlignment

getWidth

getX

getY

hasSameValues

isBackground

isImageWatermark

isTextWatermark

setBackground

setConsiderParentMargins

setHeight

setHorizontalAlignment

setMargins

setOpacity

setPagesSetup

setRotateAngle

setScaleFactor

setSizingType

setTileOptions

setVerticalAlignment

setWidth

setX

setY