HeaderFooter
Overview
HeaderFooter is a class in Aspose.Words FOSS for Java.
Inherits from: Story.
Represents a container for the header or footer text of a section.
Edition status of its 26 listed members (a property and its accessor methods are listed separately, overloads once): 26 not yet exercised by a verified example.
This class declares 17 methods for HeaderFooter objects in Java programs.
Available methods include: HeaderFooter, accept, acceptEnd, acceptStart, appendParagraph, deleteShapes, getFirstParagraph, getHeaderFooterType, getLastParagraph, getNodeType, getParagraphs, getParentSection, and 4 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: firstParagraph, header, headerFooterType, lastParagraph, linkedToPrevious, nodeType, and 4 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
nodeType | int | Read | Returns HeaderFooter. |
parentSection | Section | Read | Gets the parent section of this story. |
headerFooterType | int | Read | Gets the type of this header/footer. |
header | boolean | Read | True if this HeaderFooter object is a header. |
linkedToPrevious | boolean | Read/Write | True if this header or footer is linked to the corresponding header or footer in the previous section. |
storyType | int | Read | Gets the type of this story. |
firstParagraph | Paragraph | Read | Gets the first paragraph in the story. |
lastParagraph | Paragraph | Read | Gets the last paragraph in the story. |
paragraphs | ParagraphCollection | Read | Gets a collection of paragraphs that are immediate children of the story. |
tables | TableCollection | Read | Gets a collection of tables that are immediate children of the story. |
Methods
| Signature | Description |
|---|---|
HeaderFooter(doc: DocumentBase, headerFooterType: int) | Creates a new header or footer of the specified type. |
getNodeType() → int | Returns HeaderFooter. |
getParentSection() → Section | Gets the parent section of this story. |
getHeaderFooterType() → int | Gets the type of this header/footer. |
isHeader() → boolean | True if this HeaderFooter object is a header. |
isLinkedToPrevious() → boolean | True if this header or footer is linked to the corresponding header or footer in the previous section. |
isLinkedToPrevious(value: boolean) | Calls isLinkedToPrevious(value) on this HeaderFooter instance. |
accept(visitor: DocumentVisitor) → boolean | Calls accept(visitor) on this HeaderFooter instance. |
acceptStart(visitor: DocumentVisitor) → int | Accepts a visitor for visiting the start of the header. |
acceptEnd(visitor: DocumentVisitor) → int | Accepts a visitor for visiting the end of the header. |
getStoryType() → int | Gets the type of this story. |
getFirstParagraph() → Paragraph | Gets the first paragraph in the story. |
getLastParagraph() → Paragraph | Gets the last paragraph in the story. |
getParagraphs() → ParagraphCollection | Gets a collection of paragraphs that are immediate children of the story. |
getTables() → TableCollection | Gets a collection of tables that are immediate children of the story. |
deleteShapes() | Deletes all shapes from the text of this story. |
appendParagraph(text: String) → Paragraph | A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object. |