HeaderFooter
Overview
HeaderFooter is a class in Aspose.Words FOSS for .NET.
Inherits from: Story.
Represents a container for the header or footer text of a section.
This class provides 29 methods for working with HeaderFooter objects in .NET programs.
Available methods include: Accept, AcceptEnd, AcceptStart, AppendChild, AppendParagraph, Clone, CreateNavigator, DeleteShapes, GetAncestor, GetAncestorOf, GetChild, GetChildNodes, and 17 additional methods.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: Count, CustomNodeId, Document, FirstChild, FirstParagraph, HasChildNodes, and 15 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
NodeType | NodeType | Read | Returns HeaderFooter. |
ParentSection | Section | Read | Gets the parent section of this story. |
HeaderFooterType | HeaderFooterType | Read | Gets the type of this header/footer. |
IsHeader | bool | Read | True if this HeaderFooter object is a header. |
IsLinkedToPrevious | bool | Read/Write | True if this header or footer is linked to the corresponding header or footer in the previous section. |
StoryType | StoryType | 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. |
IsComposite | bool | Read | Returns true as this node can have child nodes. |
HasChildNodes | bool | Read | Returns true if this node has any child nodes. |
FirstChild | Node | Read | Gets the first child of the node. |
LastChild | Node | Read | Gets the last child of the node. |
Count | int | Read | Gets the number of immediate children of this node. |
ParentNode | CompositeNode | Read | Gets the immediate parent of this node. |
Document | DocumentBase | Read | Gets the document to which this node belongs. |
PreviousSibling | Node | Read | Gets the node immediately preceding this node. |
NextSibling | Node | Read | Gets the node immediately following this node. |
Range | Range | Read | Returns a Range object that represents the portion of a document that is contained in this node. |
CustomNodeId | int | Read/Write | Specifies custom node identifier. |
Methods
| Signature | Description |
|---|---|
HeaderFooter(doc: DocumentBase, headerFooterType: HeaderFooterType) | Creates a new header or footer of the specified type. |
Accept(visitor: DocumentVisitor) | Calls VisitHeaderFooterStart, then calls Accept for all child nodes of the section and calls VisitHeaderFooterEnd at the end. |
AcceptStart(visitor: DocumentVisitor) | Accepts a visitor for visiting the start of the header. |
AcceptEnd(visitor: DocumentVisitor) | Accepts a visitor for visiting the end of the header. |
DeleteShapes() | Deletes all shapes from the text of this story. |
AppendParagraph(text: string) | A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object. |
GetText() | Gets the text of this node and of all its children. |
GetChildNodes(nodeType: NodeType, isDeep: bool) | Returns a collection of child nodes that match the specified type. |
GetChild(nodeType: NodeType, index: int, isDeep: bool) | Returns an Nth child node that matches the specified type. |
SelectNodes(xpath: string) | Selects a list of nodes matching the XPath expression. |
SelectSingleNode(xpath: string) | Selects the first Node that matches the XPath expression. |
GetEnumerator() | Provides support for the for each style iteration over the child nodes of this node. |
AppendChild(newChild: T) | Adds the specified node to the end of the list of child nodes for this node. |
PrependChild(newChild: T) | Adds the specified node to the beginning of the list of child nodes for this node. |
InsertAfter(newChild: T, refChild: Node) | Inserts the specified node immediately after the specified reference node. |
InsertBefore(newChild: T, refChild: Node) | Inserts the specified node immediately before the specified reference node. |
RemoveChild(oldChild: T) | Removes the specified child node. |
RemoveAllChildren() | Removes all the child nodes of the current node. |
RemoveSmartTags() | Removes all SmartTag descendant nodes of the current node. |
IndexOf(child: Node) | Returns the index of the specified child node in the child node array. |
CreateNavigator() | Creates navigator which can be used to traverse and read nodes. |
Clone(isCloneChildren: bool) | You should use the Clone(bool, INodeCloningListener) overload when the node cloning is a part of another (usually composite) node cloning process. |
GetAncestor(ancestorType: Type) | Gets the first ancestor of the specified object type. |
GetAncestorOf() | Calls GetAncestorOf on this HeaderFooter instance. |
Remove() | Removes itself from the parent. |
NextPreOrder(rootNode: Node) | Gets next node according to the pre-order tree traversal algorithm. |
PreviousPreOrder(rootNode: Node) | Gets the previous node according to the pre-order tree traversal algorithm. |
ToString(saveFormat: SaveFormat) | Exports the content of the node into a string in the specified format. |
NodeTypeToString(nodeType: NodeType) | A utility method that converts a node type enum value into a user friendly string. |