com.aspose.words

Class PdfLoadOptions

java.lang.Object

com.aspose.words.LoadOptions

com.aspose.words.PdfLoadOptions

public class PdfLoadOptions
extends LoadOptions

Allows to specify additional options when loading Pdf document into a Document object.

To learn more, visit the Specify Load Options documentation article.

Examples:

Shows how to skip images during loading PDF files.

 
 PdfLoadOptions options = new PdfLoadOptions();
 options.setSkipPdfImages(isSkipPdfImages);
 options.setPageIndex(0);
 options.setPageCount(1);

 Document doc = new Document(getMyDir() + "Images.pdf", options);
 NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);

 if (isSkipPdfImages)
     Assert.assertEquals(shapeCollection.getCount(), 0);
 else
     Assert.assertNotEquals(shapeCollection.getCount(), 0);
 
 

Method Summary

Modifier and Type	Method and Description
int	getPageCount() Gets the number of pages to read.
int	getPageIndex() Gets the 0-based index of the first page to read.
boolean	getSkipPdfImages() Gets the flag indicating whether images must be skipped while loading PDF document.
void	setPageCount(int value) Sets the number of pages to read.
void	setPageIndex(int value) Sets the 0-based index of the first page to read.
void	setSkipPdfImages(boolean value) Sets the flag indicating whether images must be skipped while loading PDF document.

Methods inherited from class com.aspose.words.LoadOptions

equals, getBaseUri, getConvertMetafilesToPng, getConvertShapeToOfficeMath, getEncoding, getFontSettings, getIgnoreOleData, getLanguagePreferences, getLoadFormat, getMswVersion, getPassword, getPreserveIncludePictureField, getProgressCallback, getRecoveryMode, getResourceLoadingCallback, getTempFolder, getUpdateDirtyFields, getUseSystemLcid, getWarningCallback, setBaseUri, setConvertMetafilesToPng, setConvertShapeToOfficeMath, setEncoding, setFontSettings, setIgnoreOleData, setLoadFormat, setMswVersion, setPassword, setPreserveIncludePictureField, setProgressCallback, setRecoveryMode, setResourceLoadingCallback, setTempFolder, setUpdateDirtyFields, setUseSystemLcid, setWarningCallback

Methods inherited from class java.lang.Object

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

Method Detail

getPageIndex

public int getPageIndex()

Gets the 0-based index of the first page to read. Default is 0.

Examples:

Shows how to skip images during loading PDF files.

 
 PdfLoadOptions options = new PdfLoadOptions();
 options.setSkipPdfImages(isSkipPdfImages);
 options.setPageIndex(0);
 options.setPageCount(1);

 Document doc = new Document(getMyDir() + "Images.pdf", options);
 NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);

 if (isSkipPdfImages)
     Assert.assertEquals(shapeCollection.getCount(), 0);
 else
     Assert.assertNotEquals(shapeCollection.getCount(), 0);
 
 

Returns:

The 0-based index of the first page to read.

setPageIndex

public void setPageIndex(int value)

Sets the 0-based index of the first page to read. Default is 0.

Examples:

Shows how to skip images during loading PDF files.

 
 PdfLoadOptions options = new PdfLoadOptions();
 options.setSkipPdfImages(isSkipPdfImages);
 options.setPageIndex(0);
 options.setPageCount(1);

 Document doc = new Document(getMyDir() + "Images.pdf", options);
 NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);

 if (isSkipPdfImages)
     Assert.assertEquals(shapeCollection.getCount(), 0);
 else
     Assert.assertNotEquals(shapeCollection.getCount(), 0);
 
 

Parameters:

value - The 0-based index of the first page to read.

getPageCount

public int getPageCount()

Gets the number of pages to read. Default is MaxValue which means all pages of the document will be read.

Examples:

Shows how to skip images during loading PDF files.

 
 PdfLoadOptions options = new PdfLoadOptions();
 options.setSkipPdfImages(isSkipPdfImages);
 options.setPageIndex(0);
 options.setPageCount(1);

 Document doc = new Document(getMyDir() + "Images.pdf", options);
 NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);

 if (isSkipPdfImages)
     Assert.assertEquals(shapeCollection.getCount(), 0);
 else
     Assert.assertNotEquals(shapeCollection.getCount(), 0);
 
 

Returns:

The number of pages to read.

setPageCount

public void setPageCount(int value)

Sets the number of pages to read. Default is MaxValue which means all pages of the document will be read.

Examples:

Shows how to skip images during loading PDF files.

 
 PdfLoadOptions options = new PdfLoadOptions();
 options.setSkipPdfImages(isSkipPdfImages);
 options.setPageIndex(0);
 options.setPageCount(1);

 Document doc = new Document(getMyDir() + "Images.pdf", options);
 NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);

 if (isSkipPdfImages)
     Assert.assertEquals(shapeCollection.getCount(), 0);
 else
     Assert.assertNotEquals(shapeCollection.getCount(), 0);
 
 

Parameters:

value - The number of pages to read.

getSkipPdfImages

public boolean getSkipPdfImages()

Gets the flag indicating whether images must be skipped while loading PDF document. Default is false.

Examples:

Shows how to skip images during loading PDF files.

 
 PdfLoadOptions options = new PdfLoadOptions();
 options.setSkipPdfImages(isSkipPdfImages);
 options.setPageIndex(0);
 options.setPageCount(1);

 Document doc = new Document(getMyDir() + "Images.pdf", options);
 NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);

 if (isSkipPdfImages)
     Assert.assertEquals(shapeCollection.getCount(), 0);
 else
     Assert.assertNotEquals(shapeCollection.getCount(), 0);
 
 

Returns:

The flag indicating whether images must be skipped while loading PDF document.

setSkipPdfImages

public void setSkipPdfImages(boolean value)

Sets the flag indicating whether images must be skipped while loading PDF document. Default is false.

Examples:

Shows how to skip images during loading PDF files.

 
 PdfLoadOptions options = new PdfLoadOptions();
 options.setSkipPdfImages(isSkipPdfImages);
 options.setPageIndex(0);
 options.setPageCount(1);

 Document doc = new Document(getMyDir() + "Images.pdf", options);
 NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);

 if (isSkipPdfImages)
     Assert.assertEquals(shapeCollection.getCount(), 0);
 else
     Assert.assertNotEquals(shapeCollection.getCount(), 0);
 
 

Parameters:

value - The flag indicating whether images must be skipped while loading PDF document.