WordProcessingHeaderFooter
Inheritance: java.lang.Object, com.groupdocs.watermark.contents.ContentPart
public class WordProcessingHeaderFooter extends ContentPart
Represents a header/footer in a Word document.
Constructors
Constructor | Description |
---|---|
WordProcessingHeaderFooter(int headerFooterHeaderFooterType, WordProcessingSection parent, IStrategyManager strategyManager, WordProcessingHeaderFooterWrapper wrapper) |
Methods
Method | Description |
---|---|
getWrapper() | |
getHeaderFooterType() | Gets the type of this [WordProcessingHeaderFooter](../../com.groupdocs.watermark.contents/wordprocessingheaderfooter) . |
getSection() | Gets the parent section of this [WordProcessingHeaderFooter](../../com.groupdocs.watermark.contents/wordprocessingheaderfooter) . |
isLinkedToPrevious() | Gets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section. |
setLinkedToPrevious(boolean value) | Sets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section. |
isVisible() | |
addWatermark(Watermark watermark, IWordProcessingWatermarkEffects effects, WordProcessingShapeSettings shapeSettings) |
WordProcessingHeaderFooter(int headerFooterHeaderFooterType, WordProcessingSection parent, IStrategyManager strategyManager, WordProcessingHeaderFooterWrapper wrapper)
public WordProcessingHeaderFooter(int headerFooterHeaderFooterType, WordProcessingSection parent, IStrategyManager strategyManager, WordProcessingHeaderFooterWrapper wrapper)
Parameters:
Parameter | Type | Description |
---|---|---|
headerFooterHeaderFooterType | int | |
parent | WordProcessingSection | |
strategyManager | IStrategyManager | |
wrapper | WordProcessingHeaderFooterWrapper |
getWrapper()
public final WordProcessingHeaderFooterWrapper getWrapper()
Returns: WordProcessingHeaderFooterWrapper
getHeaderFooterType()
public final int getHeaderFooterType()
Gets the type of this [WordProcessingHeaderFooter](../../com.groupdocs.watermark.contents/wordprocessingheaderfooter)
.
Returns:
int - The type of this [WordProcessingHeaderFooter](../../com.groupdocs.watermark.contents/wordprocessingheaderfooter)
.
getSection()
public final WordProcessingSection getSection()
Gets the parent section of this [WordProcessingHeaderFooter](../../com.groupdocs.watermark.contents/wordprocessingheaderfooter)
.
Returns:
WordProcessingSection - The parent section of this [WordProcessingHeaderFooter](../../com.groupdocs.watermark.contents/wordprocessingheaderfooter)
.
isLinkedToPrevious()
public final boolean isLinkedToPrevious()
Gets a value indicating whether this header/footer is linked to the corresponding header/footer in the previous section.
Default is true.
Returns:
boolean - true
if this header/footer is linked to the corresponding header/footer in the previous section; false
otherwise.
setLinkedToPrevious(boolean value)
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.
Note, when your link a header or footer, its contents is cleared.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | true if this header/footer has to be linked to the corresponding header/footer in the previous section; false otherwise. |
isVisible()
public final boolean isVisible()
Returns: boolean
addWatermark(Watermark watermark, IWordProcessingWatermarkEffects effects, WordProcessingShapeSettings shapeSettings)
public final void addWatermark(Watermark watermark, IWordProcessingWatermarkEffects effects, WordProcessingShapeSettings shapeSettings)
Parameters:
Parameter | Type | Description |
---|---|---|
watermark | Watermark | |
effects | IWordProcessingWatermarkEffects | |
shapeSettings | WordProcessingShapeSettings |