com.aspose.words

Class HeaderFooterType

java.lang.Object

com.aspose.words.HeaderFooterType

public class HeaderFooterType
extends java.lang.Object

Identifies the type of header or footer found in a Word file. This is a per section header/footer. Do not renumber as the value of the enum used as an index into plcfhdd.

Examples:

Shows how to create headers and footers in a document using DocumentBuilder.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Specify that we want different headers and footers for first, even and odd pages.
 builder.getPageSetup().setDifferentFirstPageHeaderFooter(true);
 builder.getPageSetup().setOddAndEvenPagesHeaderFooter(true);

 // Create the headers, then add three pages to the document to display each header type.
 builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
 builder.write("Header for the first page");
 builder.moveToHeaderFooter(HeaderFooterType.HEADER_EVEN);
 builder.write("Header for even pages");
 builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
 builder.write("Header for all other pages");

 builder.moveToSection(0);
 builder.writeln("Page1");
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.writeln("Page2");
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.writeln("Page3");

 doc.save(getArtifactsDir() + "DocumentBuilder.HeadersAndFooters.docx");
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	FOOTER_EVEN Footer for even numbered pages.
static int	FOOTER_FIRST Footer for the first page of the section.
static int	FOOTER_PRIMARY Primary footer, also used for odd numbered pages.
static int	HEADER_EVEN Header for even numbered pages.
static int	HEADER_FIRST Header for the first page of the section.
static int	HEADER_PRIMARY Primary header, also used for odd numbered pages.
static int	length

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String headerFooterTypeName)
static java.lang.String	getName(int headerFooterType)
static int[]	getValues()
static java.lang.String	toString(int headerFooterType)

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_EVEN

public static int HEADER_EVEN

Header for even numbered pages.

HEADER_PRIMARY

public static int HEADER_PRIMARY

Primary header, also used for odd numbered pages.

FOOTER_EVEN

public static int FOOTER_EVEN

Footer for even numbered pages.

FOOTER_PRIMARY

public static int FOOTER_PRIMARY

Primary footer, also used for odd numbered pages.

HEADER_FIRST

public static int HEADER_FIRST

Header for the first page of the section.

FOOTER_FIRST

public static int FOOTER_FIRST

Footer for the first page of the section.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int headerFooterType)

toString

public static java.lang.String toString(int headerFooterType)

fromName

public static int fromName(java.lang.String headerFooterTypeName)

getValues

public static int[] getValues()