com.aspose.words

Class HeaderFooterBookmarksExportMode

java.lang.Object

com.aspose.words.HeaderFooterBookmarksExportMode

public class HeaderFooterBookmarksExportMode
extends java.lang.Object

Specifies how bookmarks in headers/footers are exported.

Examples:

Shows to process bookmarks in headers/footers in a document that we are rendering to PDF.

 
 Document doc = new Document(getMyDir() + "Bookmarks in headers and footers.docx");

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions saveOptions = new PdfSaveOptions();

 // Set the "PageMode" property to "PdfPageMode.UseOutlines" to display the outline navigation pane in the output PDF.
 saveOptions.setPageMode(PdfPageMode.USE_OUTLINES);

 // Set the "DefaultBookmarksOutlineLevel" property to "1" to display all
 // bookmarks at the first level of the outline in the output PDF.
 saveOptions.getOutlineOptions().setDefaultBookmarksOutlineLevel(1);

 // Set the "HeaderFooterBookmarksExportMode" property to "HeaderFooterBookmarksExportMode.None" to
 // not export any bookmarks that are inside headers/footers.
 // Set the "HeaderFooterBookmarksExportMode" property to "HeaderFooterBookmarksExportMode.First" to
 // only export bookmarks in the first section's header/footers.
 // Set the "HeaderFooterBookmarksExportMode" property to "HeaderFooterBookmarksExportMode.All" to
 // export bookmarks that are in all headers/footers.
 saveOptions.setHeaderFooterBookmarksExportMode(headerFooterBookmarksExportMode);

 doc.save(getArtifactsDir() + "PdfSaveOptions.HeaderFooterBookmarksExportMode.pdf", saveOptions);
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL Bookmarks in all headers/footers are exported.
static int	FIRST Only bookmark in first header/footer of the section is exported.
static int	length
static int	NONE Bookmarks in headers/footers are not exported.

Method Summary

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

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

Bookmarks in headers/footers are not exported.

FIRST

public static int FIRST

Only bookmark in first header/footer of the section is exported.

ALL

public static int ALL

Bookmarks in all headers/footers are exported.

length

public static int length

Method Detail

getName

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

toString

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

fromName

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

getValues

public static int[] getValues()