com.groupdocs.watermark.options

Interfaces

Classes

com.groupdocs.watermark.options

Class WordProcessingWatermarkBaseOptions

    • Constructor Detail

      • WordProcessingWatermarkBaseOptions

        protected WordProcessingWatermarkBaseOptions()

        Initializes a new instance of the WordProcessingWatermarkBaseOptions 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.
      • getName

        public final String getName()

        Gets the name a shape.

        Returns:
        The shape name.
      • setName

        public final void setName(String value)

        Sets the name a shape.

        Parameters:
        value - The shape name.
      • getAlternativeText

        public final String getAlternativeText()

        Gets the descriptive (alternative) text that will be associated with a shape.

        Returns:
        The descriptive (alternative) text that will be associated with a shape.
      • setAlternativeText

        public final void setAlternativeText(String value)

        Sets the descriptive (alternative) text that will be associated with a shape.

        Parameters:
        value - The descriptive (alternative) text that will be associated with a shape.
      • getEffects

        public final IWordProcessingWatermarkEffects getEffects()

        Gets or sets a value of WordProcessingImageEffects or WordProcessingTextEffects for effects that should be applied to the watermark.

      • setEffects

        public final void setEffects(IWordProcessingWatermarkEffects value)

        Gets or sets a value of WordProcessingImageEffects or WordProcessingTextEffects for effects that should be applied to the watermark.