com.groupdocs.watermark

Class Watermark

    • Method Detail

      • 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.
      • 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.
      • getY

        public final double getY()
        Gets the y-coordinate of this Watermark.
        Returns:
        The y-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.
      • getX

        public final double getX()
        Gets the x-coordinate of this Watermark.
        Returns:
        The x-coordinate 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.
      • getRotateAngle

        public final double getRotateAngle()
        Gets the rotate angle of this Watermark in degrees.
        Returns:
        The rotate angle of this Watermark in degrees.
      • 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.
      • 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.
      • 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.
      • getMargins

        public final Margins getMargins()
        Gets the margin settings of this Watermark.
        Returns:
        The margin settings 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.
      • getHeight

        public final double getHeight()
        Gets the desired height of this Watermark.
        Returns:
        The desired height of this Watermark.
      • getWidth

        public final double getWidth()
        Gets the desired width of this Watermark.
        Returns:
        The desired width of this Watermark.
      • 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.
      • 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.
      • getSizingType

        public final int getSizingType()

        Gets a value specifying a way watermark should be sized.

        Returns:
        The sizing type.
      • setSizingType

        public final void setSizingType(int value)

        Sets a value specifying a way watermark should be sized.

        Parameters:
        value - The sizing type.
      • 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.
      • 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.