com.aspose.words

Class HeaderFooterCollection

java.lang.Object

com.aspose.words.NodeCollection

com.aspose.words.HeaderFooterCollection

All Implemented Interfaces:

java.lang.Iterable

public class HeaderFooterCollection
extends NodeCollection

Provides typed access to HeaderFooter nodes of a Section.

There can be maximum of one HeaderFooter

of each HeaderFooterType per Section.

HeaderFooter objects can occur in any order in the collection.

Method Summary

Modifier and Type	Method and Description
Node	get(int index) Retrieves a HeaderFooter at the given index.
HeaderFooter	getByHeaderFooterType(int headerFooterType)
void	linkToPrevious(boolean isLinkToPrevious) Links or unlinks all headers and footers to the corresponding headers and footers in the previous section.
void	linkToPrevious(int headerFooterType, boolean isLinkToPrevious)
HeaderFooter[]	toArray() Copies all HeaderFoorter s from the collection to a new array of HeaderFoorter s.

Methods inherited from class com.aspose.words.NodeCollection

add, clear, contains, getContainer, getCount, getCurrentNode, getNextMatchingNode, indexOf, insert, iterator, remove, removeAt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get

public Node get(int index)

Retrieves a HeaderFooter at the given index.

The index is zero-based.

Negative indexes are allowed and indicate access from the back of the collection. For example -1 means the last item, -2 means the second before last and so on.

If index is greater than or equal to the number of items in the list, this returns a null reference.

If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.

Overrides:

get in class NodeCollection

Parameters:

index - An index into the collection.

Returns:

The corresponding HeaderFooter value.

getByHeaderFooterType

public HeaderFooter getByHeaderFooterType(int headerFooterType)

linkToPrevious

public void linkToPrevious(boolean isLinkToPrevious)

Links or unlinks all headers and footers to the corresponding headers and footers in the previous section.

If any of the headers or footers do not exist, creates them automatically.

Parameters:

isLinkToPrevious - True to link the headers and footers to the previous section; false to unlink them.

linkToPrevious

public void linkToPrevious(int headerFooterType,
                           boolean isLinkToPrevious)

toArray

public HeaderFooter[] toArray()

Copies all HeaderFoorter s from the collection to a new array of HeaderFoorter s.

Overrides:

toArray in class NodeCollection

Returns:

An array of HeaderFoorter s.