com.groupdocs.watermark.options

Interfaces

Classes

com.groupdocs.watermark.options

Class PresentationWatermarkBaseSlideOptions

  • Direct Known Subclasses:
    PresentationWatermarkLayoutSlideOptions, PresentationWatermarkMasterHandoutSlideOptions, PresentationWatermarkMasterNotesSlideOptions, PresentationWatermarkMasterSlideOptions, PresentationWatermarkNoteSlideOptions, PresentationWatermarkSlideOptions

    public abstract class PresentationWatermarkBaseSlideOptions
extends PresentationWatermarkOptions
    Base class for watermark adding options to a Presentation document.

    Learn more:

    The following example demonstrates how to add a watermark to different service slides of a Power Point presentation. 

    PresentationLoadOptions loadOptions = new PresentationLoadOptions();
   Watermarker watermarker = new Watermarker("D:\\test.pptx", loadOptions);

   TextWatermark watermark = new TextWatermark("Test watermark", new Font("Arial", 8));

   // Add watermark to all master slides
   PresentationWatermarkMasterSlideOptions masterSlideOptions = new PresentationWatermarkMasterSlideOptions();
   masterSlideOptions.setMasterSlideIndex(-1); // default
   watermarker.add(watermark, masterSlideOptions);
   
   // Add watermark to all layout slides
   PresentationWatermarkLayoutSlideOptions layoutSlideOptions = new PresentationWatermarkLayoutSlideOptions();
   layoutSlideOptions.setLayoutSlideIndex(-1); // default
   watermarker.add(watermark, layoutSlideOptions);
   
   // Add watermark to all notes slides
   PresentationWatermarkNoteSlideOptions noteSlideOptions = new PresentationWatermarkNoteSlideOptions();
   noteSlideOptions.setSlideIndex(-1); // default
   watermarker.add(watermark, noteSlideOptions);
   
   // Add watermark to handout master
   PresentationWatermarkMasterHandoutSlideOptions masterHandoutSlideOptions = new PresentationWatermarkMasterHandoutSlideOptions();
   watermarker.add(watermark, masterHandoutSlideOptions);
   
   // Add watermark to notes master
   PresentationWatermarkMasterNotesSlideOptions masterNotesSlideOptions = new PresentationWatermarkMasterNotesSlideOptions();
   watermarker.add(watermark, masterNotesSlideOptions);
   
   watermarker.save("D:\\watermarked_test.pptx");
   watermarker.close();

    • Method Detail

      • isLocked

        public final boolean isLocked()

        Gets a value indicating whether an editing of the shape in PowerPoint 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 PowerPoint.

      • setLocked

        public final void setLocked(boolean value)

        Sets a value indicating whether an editing of the shape in PowerPoint 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 PowerPoint.

      • getProtectWithUnreadableCharacters

        public final boolean getProtectWithUnreadableCharacters()
        Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

        This protection applies only when PresentationWatermarkBaseSlideOptions.isLocked() returns true.

        Returns:
        A value indicating whether the text watermark characters are mixed with unreadable characters.

      • setProtectWithUnreadableCharacters

        public final void setProtectWithUnreadableCharacters(boolean value)
        Gets or sets a value indicating whether the text watermark characters are mixed with unreadable characters.

        This protection applies only when PresentationWatermarkBaseSlideOptions.isLocked() returns true.

        Parameters:
        value - A value indicating whether the text watermark characters are mixed with unreadable characters.

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