@Deprecated public class WordsHeaderFooter extends DocumentPart
Represents a header/footer in a Word document.
Modifier and Type | Method and Description |
---|---|
void |
addImageWatermark(ImageWatermark watermark,
WordsImageEffects effects)
Deprecated.
Adds an image watermark to this
WordsHeaderFooter . |
void |
addImageWatermark(ImageWatermark watermark,
WordsImageEffects effects,
WordsShapeSettings shapeSettings)
Deprecated.
Adds an image watermark to this
WordsHeaderFooter . |
void |
addTextWatermark(TextWatermark watermark,
WordsTextEffects effects)
Deprecated.
Adds a text watermark to this
WordsHeaderFooter . |
void |
addTextWatermark(TextWatermark watermark,
WordsTextEffects effects,
WordsShapeSettings shapeSettings)
Deprecated.
Adds a text watermark to this
WordsHeaderFooter . |
void |
addWatermark(Watermark watermark,
WordsShapeSettings shapeSettings)
Deprecated.
Adds a watermark to this
WordsHeaderFooter . |
int |
getHeaderFooterType()
Deprecated.
Gets the type of this
WordsHeaderFooter . |
WordsSection |
getSection()
Deprecated.
Gets the parent section of this
WordsHeaderFooter . |
boolean |
isLinkedToPrevious()
Deprecated.
Gets a value indicating whether this header/footer is linked to
the corresponding header/footer in the previous section.
|
void |
setLinkedToPrevious(boolean value)
Deprecated.
Sets a value indicating whether this header/footer is linked to
the corresponding header/footer in the previous section.
|
addWatermark, findImages, findImages, findWatermarks, findWatermarks
public final int getHeaderFooterType()
Gets the type of this WordsHeaderFooter
.
WordsHeaderFooter
.public final WordsSection getSection()
Gets the parent section of this WordsHeaderFooter
.
WordsHeaderFooter
.public final boolean isLinkedToPrevious()
Gets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section.
<p>Default is true.</p>
<p>Note, when your link a header or footer, its contents is cleared.</p>
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.
value
- <p>Default is true.</p>
<p>Note, when your link a header or footer, its contents is cleared.</p>
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).
watermark
- The watermark to add to the header/footer.shapeSettings
- Settings that should be applied to the watermark.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).
watermark
- The text watermark to add to the header/footer.effects
- Text effects that should be applied to the watermark.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).
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.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).
watermark
- The image watermark to add to the header/footer.effects
- Image effects that should be applied to the watermark.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).
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.