com.groupdocs.watermark.options

Interfaces

Classes

com.groupdocs.watermark.options

Class WordProcessingShapeSettings



  • public final class WordProcessingShapeSettings
    extends OfficeShapeSettings

    Represents settings that can be applied to a shape watermark for a Word document.

    • Constructor Detail

      • WordProcessingShapeSettings

        public WordProcessingShapeSettings()

        Initializes a new instance of the WordProcessingShapeSettings class.

    • Method Detail

      • isLocked

        public final boolean isLocked()

        Gets a value indicating whether an editing of the shape in Word is forbidden.

        Returns:
        If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Word.
      • setLocked

        public final void setLocked(boolean value)

        Sets a value indicating whether an editing of the shape in Word is forbidden.

        Parameters:
        value - If the value is true, shape editing will be forbidden. By default, the value is false, the shape can be edited in Word.
      • getLockType

        public final int getLockType()

        Gets the watermark lock type. Value WordProcessingLockType.AllowOnlyFormFields can not be used with an object of type WordProcessingHeaderFooter.

        Returns:
        The watermark lock type.
      • setLockType

        public final void setLockType(int value)

        Sets the watermark lock type. Value WordProcessingLockType.AllowOnlyFormFields can not be used with an object of type WordProcessingHeaderFooter.

        Parameters:
        value - The watermark lock type.
      • getPassword

        public final String getPassword()

        Gets a password used to lock the watermark.

        Returns:
        A password used to lock the watermark.
      • setPassword

        public final void setPassword(String value)

        Sets a password used to lock the watermark.

        Parameters:
        value - A password used to lock the watermark.
      • getPageNumbers

        public final int[] getPageNumbers()

        Gets the page numbers to add the watermark. All numbers must be greater than or equal to 1. This property is only used when adding the watermark to a content. If this value is null, the watermark is added to all pages.

        Returns:
        The page numbers to add the watermark.
      • setPageNumbers

        public final void setPageNumbers(int[] value)

        Sets the page numbers to add the watermark. All numbers must be greater than or equal to 1. This property is only used when adding the watermark to a content. If this value is null, the watermark is added to all pages.

        Parameters:
        value - The page numbers to add the watermark.