com.aspose.words

Class HeaderFooterBookmarksExportMode

  • java.lang.Object
    • com.aspose.words.HeaderFooterBookmarksExportMode
public class HeaderFooterBookmarksExportMode 
extends java.lang.Object

Utility class containing constants. Specifies how bookmarks in headers/footers are exported.

Example:

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
static final intNONE = 0
Bookmarks in headers/footers are not exported.
static final intFIRST = 1
Only bookmark in first header/footer of the section is exported.
static final intALL = 2
Bookmarks in all headers/footers are exported.
 

    • Field Detail

      • NONE = 0

        public static final int NONE
        Bookmarks in headers/footers are not exported.
      • FIRST = 1

        public static final int FIRST
        Only bookmark in first header/footer of the section is exported.
      • ALL = 2

        public static final int ALL
        Bookmarks in all headers/footers are exported.