com.aspose.words

Class PdfPageMode

java.lang.Object

com.aspose.words.PdfPageMode

public class PdfPageMode
extends java.lang.Object

Specifies how the PDF document should be displayed when opened in the PDF reader.

Examples:

Shows how to set instructions for some PDF readers to follow when opening an output document.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 builder.writeln("Hello world!");

 // 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 options = new PdfSaveOptions();

 // Set the "PageMode" property to "PdfPageMode.FullScreen" to get the PDF reader to open the saved
 // document in full-screen mode, which takes over the monitor's display and has no controls visible.
 // Set the "PageMode" property to "PdfPageMode.UseThumbs" to get the PDF reader to display a separate panel
 // with a thumbnail for each page in the document.
 // Set the "PageMode" property to "PdfPageMode.UseOC" to get the PDF reader to display a separate panel
 // that allows us to work with any layers present in the document.
 // Set the "PageMode" property to "PdfPageMode.UseOutlines" to get the PDF reader
 // also to display the outline, if possible.
 // Set the "PageMode" property to "PdfPageMode.UseNone" to get the PDF reader to display just the document itself.
 // Set the "PageMode" property to "PdfPageMode.UseAttachments" to make visible attachments panel.
 options.setPageMode(pageMode);

 doc.save(getArtifactsDir() + "PdfSaveOptions.PageMode.pdf", options);
 
 

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	FULL_SCREEN Full-screen mode, with no menu bar, window controls, or any other window visible.
static int	length
static int	USE_ATTACHMENTS Attachments panel is visible.
static int	USE_NONE Neither document outline nor thumbnail images are visible.
static int	USE_OC Optional content group panel is visible.
static int	USE_OUTLINES Document outline is visible.
static int	USE_THUMBS Thumbnail images are visible.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

USE_NONE

public static int USE_NONE

Neither document outline nor thumbnail images are visible.

USE_OUTLINES

public static int USE_OUTLINES

Document outline is visible. Note that if there're no outlines in the PDF document then outline navigation pane will not be visible anyway.

USE_THUMBS

public static int USE_THUMBS

Thumbnail images are visible.

FULL_SCREEN

public static int FULL_SCREEN

Full-screen mode, with no menu bar, window controls, or any other window visible.

USE_OC

public static int USE_OC

Optional content group panel is visible.

Remarks:

Not supported in the following PDF versions: PdfCompliance.PDF_A_1_A, PdfCompliance.PDF_A_1_B.

USE_ATTACHMENTS

public static int USE_ATTACHMENTS

Attachments panel is visible.

Remarks:

Not supported in the following PDF versions: PdfCompliance.PDF_A_1_A, PdfCompliance.PDF_A_1_B.

length

public static int length

Method Detail

getName

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

toString

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

fromName

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

getValues

public static int[] getValues()