com.aspose.words

Class ExportHeadersFootersMode

java.lang.Object

com.aspose.words.ExportHeadersFootersMode

public class ExportHeadersFootersMode
extends java.lang.Object

Specifies how headers and footers are exported to HTML, MHTML or EPUB.

Examples:

Shows how to omit headers/footers when saving a document to HTML.

 
 Document doc = new Document(getMyDir() + "Header and footer types.docx");

 // This document contains headers and footers. We can access them via the "HeadersFooters" collection.
 Assert.assertEquals("First header", doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.HEADER_FIRST).getText().trim());

 // Formats such as .html do not split the document into pages, so headers/footers will not function the same way
 // they would when we open the document as a .docx using Microsoft Word.
 // If we convert a document with headers/footers to html, the conversion will assimilate the headers/footers into body text.
 // We can use a SaveOptions object to omit headers/footers while converting to html.
 HtmlSaveOptions saveOptions =
         new HtmlSaveOptions(SaveFormat.HTML);
 {
     saveOptions.setExportHeadersFootersMode(ExportHeadersFootersMode.NONE);
 }

 doc.save(getArtifactsDir() + "HeaderFooter.ExportMode.html", saveOptions);

 // Open our saved document and verify that it does not contain the header's text.
 doc = new Document(getArtifactsDir() + "HeaderFooter.ExportMode.html");

 Assert.assertFalse(doc.getRange().getText().contains("First header"));
 
 

See Also:

HtmlSaveOptions.getExportHeadersFootersMode(), HtmlSaveOptions.setExportHeadersFootersMode(int)

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIRST_PAGE_HEADER_FOOTER_PER_SECTION First page header and footer are exported at the beginning and the end of each section.
static int	FIRST_SECTION_HEADER_LAST_SECTION_FOOTER Primary header of the first section is exported at the beginning of the document and primary footer is at the end.
static int	length
static int	NONE Headers and footers are not exported.
static int	PER_SECTION Primary headers and footers are exported at the beginning and the end of each section.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static int NONE

Headers and footers are not exported.

PER_SECTION

public static int PER_SECTION

Primary headers and footers are exported at the beginning and the end of each section.

FIRST_SECTION_HEADER_LAST_SECTION_FOOTER

public static int FIRST_SECTION_HEADER_LAST_SECTION_FOOTER

Primary header of the first section is exported at the beginning of the document and primary footer is at the end.

FIRST_PAGE_HEADER_FOOTER_PER_SECTION

public static int FIRST_PAGE_HEADER_FOOTER_PER_SECTION

First page header and footer are exported at the beginning and the end of each section.

length

public static int length

Method Detail

getName

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

toString

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

fromName

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

getValues

public static int[] getValues()