com.groupdocs.watermark

Interfaces

Classes

Exceptions

com.groupdocs.watermark

Class WordsHeaderFooter



  • public class WordsHeaderFooter
    extends DocumentPart

    Represents a header/footer in a Word document.

    • Method Detail

      • getHeaderFooterType

        public final int getHeaderFooterType()

        Gets the type of this WordsHeaderFooter.

        Returns:
        The type of this WordsHeaderFooter.
      • getSection

        public final WordsSection getSection()

        Gets the parent section of this WordsHeaderFooter.

        Returns:
        The parent section of this WordsHeaderFooter.
      • isLinkedToPrevious

        public final boolean isLinkedToPrevious()

        Gets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section.

        Returns:
        <p>Default is true.</p> <p>Note, when your link a header or footer, its contents is cleared.</p>
      • setLinkedToPrevious

        public final void setLinkedToPrevious(boolean value)

        Sets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section.

        Parameters:
        value - <p>Default is true.</p> <p>Note, when your link a header or footer, its contents is cleared.</p>
      • addWatermark

        public final void addWatermark(Watermark watermark,
                        WordsShapeSettings shapeSettings)

        Adds a watermark to this WordsHeaderFooter. This method assumes that watermark offset and size are measured in points (if they are assigned).

        Parameters:
        watermark - The watermark to add to the header/footer.
        shapeSettings - Settings that should be applied to the watermark.
      • addTextWatermark

        public final void addTextWatermark(TextWatermark watermark,
                            WordsTextEffects effects)

        Adds a text watermark to this WordsHeaderFooter. This method assumes that watermark offset and size are measured in points (if they are assigned).

        Parameters:
        watermark - The text watermark to add to the header/footer.
        effects - Text effects that should be applied to the watermark.
      • addTextWatermark

        public final void addTextWatermark(TextWatermark watermark,
                            WordsTextEffects effects,
                            WordsShapeSettings shapeSettings)

        Adds a text watermark to this WordsHeaderFooter. This method assumes that watermark offset and size are measured in points (if they are assigned).

        Parameters:
        watermark - The text watermark to add to the header/footer.
        effects - Text effects that should be applied to the watermark.
        shapeSettings - Shape settings that should be applied to the watermark.
      • addImageWatermark

        public final void addImageWatermark(ImageWatermark watermark,
                             WordsImageEffects effects)

        Adds an image watermark to this WordsHeaderFooter. This method assumes that watermark offset and size are measured in points (if they are assigned).

        Parameters:
        watermark - The image watermark to add to the header/footer.
        effects - Image effects that should be applied to the watermark.
      • addImageWatermark

        public final void addImageWatermark(ImageWatermark watermark,
                             WordsImageEffects effects,
                             WordsShapeSettings shapeSettings)

        Adds an image watermark to this WordsHeaderFooter. This method assumes that watermark offset and size are measured in points (if they are assigned).

        Parameters:
        watermark - The image watermark to add to the header/footer.
        effects - Image effects that should be applied to the watermark.
        shapeSettings - Shape settings that should be applied to the watermark.