PdfConvertOptions (groupdocs-conversion-cloud 25.9 API)

java.lang.Object
- com.groupdocs.cloud.conversion.model.ConvertOptions
- - com.groupdocs.cloud.conversion.model.PdfConvertOptions

public class PdfConvertOptions
extends ConvertOptions

Options for to PDF conversion

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PdfConvertOptions.DirectionEnum`	Sets reading order of text: L2R (left to right) or R2L (right to left).
`static class`	`PdfConvertOptions.NonFullScreenPageModeEnum`	Sets page mode, specifying how to display the document on exiting full-screen mode.
`static class`	`PdfConvertOptions.PageLayoutEnum`	Sets page layout which shall be used when the document is opened.
`static class`	`PdfConvertOptions.PageModeEnum`	Sets page mode, specifying how document should be displayed when opened.
`static class`	`PdfConvertOptions.PageOrientationEnum`	Specifies page orientation
`static class`	`PdfConvertOptions.PageSizeEnum`	Specifies page size
`static class`	`PdfConvertOptions.PdfFormatEnum`	Set the pdf format of the converted document.
`static class`	`PdfConvertOptions.RotateEnum`	Rotate page

Constructor Summary

Constructors
Constructor Description

PdfConvertOptions()

Constructors
Constructor	Description
`PdfConvertOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PdfConvertOptions`	`centerWindow(Boolean centerWindow)`
`PdfConvertOptions`	`compressImages(Boolean compressImages)`
`PdfConvertOptions`	`direction(PdfConvertOptions.DirectionEnum direction)`
`PdfConvertOptions`	`displayDocTitle(Boolean displayDocTitle)`
`PdfConvertOptions`	`dpi(Integer dpi)`
`boolean`	`equals(Object o)`
`PdfConvertOptions`	`fitWindow(Boolean fitWindow)`
`Boolean`	`getCenterWindow()`	Specify whether position of the document's window will be centered on the screen.
`Boolean`	`getCompressImages()`	If CompressImages set to true, all images in the document are recompressed.
`PdfConvertOptions.DirectionEnum`	`getDirection()`	Sets reading order of text: L2R (left to right) or R2L (right to left).
`Boolean`	`getDisplayDocTitle()`	Specifying whether document's window title bar should display document title.
`Integer`	`getDpi()`	Desired page DPI after conversion.
`Boolean`	`getFitWindow()`	Specify whether document window must be resized to fit the first displayed page.
`Boolean`	`getGrayscale()`	Convert a PDF from RGB colorspace to Grayscale
`Integer`	`getHeight()`	Desired page height in pixels after conversion
`Boolean`	`getHideMenuBar()`	Specify whether menu bar should be hidden when document is active.
`Boolean`	`getHideToolBar()`	Specifying whether toolbar should be hidden when document is active.
`Boolean`	`getHideWindowUI()`	Specify whether user interface elements should be hidden when document is active.
`Integer`	`getImageQuality()`	Value in percent where 100% is unchanged quality and image size.
`Boolean`	`getLinearize()`	Linearize PDF Document for the Web
`Boolean`	`getLinkDuplicateStreams()`	Link duplicate streams
`Integer`	`getMarginBottom()`	Desired page bottom margin in pixels after conversion
`Integer`	`getMarginLeft()`	Desired page left margin in pixels after conversion
`Integer`	`getMarginRight()`	Desired page right margin in pixels after conversion
`Integer`	`getMarginTop()`	Desired page top margin in pixels after conversion
`PdfConvertOptions.NonFullScreenPageModeEnum`	`getNonFullScreenPageMode()`	Sets page mode, specifying how to display the document on exiting full-screen mode.
`PdfConvertOptions.PageLayoutEnum`	`getPageLayout()`	Sets page layout which shall be used when the document is opened.
`PdfConvertOptions.PageModeEnum`	`getPageMode()`	Sets page mode, specifying how document should be displayed when opened.
`PdfConvertOptions.PageOrientationEnum`	`getPageOrientation()`	Specifies page orientation
`PdfConvertOptions.PageSizeEnum`	`getPageSize()`	Specifies page size
`String`	`getPassword()`	Set this property if you want to protect the converted document with a password
`PdfConvertOptions.PdfFormatEnum`	`getPdfFormat()`	Set the pdf format of the converted document.
`Boolean`	`getRemovePdfaCompliance()`	Remove Pdf-A Compliance
`Boolean`	`getRemoveUnusedObjects()`	Remove unused objects
`Boolean`	`getRemoveUnusedStreams()`	Remove unused streams
`PdfConvertOptions.RotateEnum`	`getRotate()`	Rotate page
`Boolean`	`getUnembedFonts()`	Make fonts not embedded if set to true
`Integer`	`getWidth()`	Desired page width in pixels after conversion
`Integer`	`getZoom()`	Specifies the zoom level in percentage.
`PdfConvertOptions`	`grayscale(Boolean grayscale)`
`int`	`hashCode()`
`PdfConvertOptions`	`height(Integer height)`
`PdfConvertOptions`	`hideMenuBar(Boolean hideMenuBar)`
`PdfConvertOptions`	`hideToolBar(Boolean hideToolBar)`
`PdfConvertOptions`	`hideWindowUI(Boolean hideWindowUI)`
`PdfConvertOptions`	`imageQuality(Integer imageQuality)`
`PdfConvertOptions`	`linearize(Boolean linearize)`
`PdfConvertOptions`	`linkDuplicateStreams(Boolean linkDuplicateStreams)`
`PdfConvertOptions`	`marginBottom(Integer marginBottom)`
`PdfConvertOptions`	`marginLeft(Integer marginLeft)`
`PdfConvertOptions`	`marginRight(Integer marginRight)`
`PdfConvertOptions`	`marginTop(Integer marginTop)`
`PdfConvertOptions`	`nonFullScreenPageMode(PdfConvertOptions.NonFullScreenPageModeEnum nonFullScreenPageMode)`
`PdfConvertOptions`	`pageLayout(PdfConvertOptions.PageLayoutEnum pageLayout)`
`PdfConvertOptions`	`pageMode(PdfConvertOptions.PageModeEnum pageMode)`
`PdfConvertOptions`	`pageOrientation(PdfConvertOptions.PageOrientationEnum pageOrientation)`
`PdfConvertOptions`	`pageSize(PdfConvertOptions.PageSizeEnum pageSize)`
`PdfConvertOptions`	`password(String password)`
`PdfConvertOptions`	`pdfFormat(PdfConvertOptions.PdfFormatEnum pdfFormat)`
`PdfConvertOptions`	`removePdfaCompliance(Boolean removePdfaCompliance)`
`PdfConvertOptions`	`removeUnusedObjects(Boolean removeUnusedObjects)`
`PdfConvertOptions`	`removeUnusedStreams(Boolean removeUnusedStreams)`
`PdfConvertOptions`	`rotate(PdfConvertOptions.RotateEnum rotate)`
`void`	`setCenterWindow(Boolean centerWindow)`
`void`	`setCompressImages(Boolean compressImages)`
`void`	`setDirection(PdfConvertOptions.DirectionEnum direction)`
`void`	`setDisplayDocTitle(Boolean displayDocTitle)`
`void`	`setDpi(Integer dpi)`
`void`	`setFitWindow(Boolean fitWindow)`
`void`	`setGrayscale(Boolean grayscale)`
`void`	`setHeight(Integer height)`
`void`	`setHideMenuBar(Boolean hideMenuBar)`
`void`	`setHideToolBar(Boolean hideToolBar)`
`void`	`setHideWindowUI(Boolean hideWindowUI)`
`void`	`setImageQuality(Integer imageQuality)`
`void`	`setLinearize(Boolean linearize)`
`void`	`setLinkDuplicateStreams(Boolean linkDuplicateStreams)`
`void`	`setMarginBottom(Integer marginBottom)`
`void`	`setMarginLeft(Integer marginLeft)`
`void`	`setMarginRight(Integer marginRight)`
`void`	`setMarginTop(Integer marginTop)`
`void`	`setNonFullScreenPageMode(PdfConvertOptions.NonFullScreenPageModeEnum nonFullScreenPageMode)`
`void`	`setPageLayout(PdfConvertOptions.PageLayoutEnum pageLayout)`
`void`	`setPageMode(PdfConvertOptions.PageModeEnum pageMode)`
`void`	`setPageOrientation(PdfConvertOptions.PageOrientationEnum pageOrientation)`
`void`	`setPageSize(PdfConvertOptions.PageSizeEnum pageSize)`
`void`	`setPassword(String password)`
`void`	`setPdfFormat(PdfConvertOptions.PdfFormatEnum pdfFormat)`
`void`	`setRemovePdfaCompliance(Boolean removePdfaCompliance)`
`void`	`setRemoveUnusedObjects(Boolean removeUnusedObjects)`
`void`	`setRemoveUnusedStreams(Boolean removeUnusedStreams)`
`void`	`setRotate(PdfConvertOptions.RotateEnum rotate)`
`void`	`setUnembedFonts(Boolean unembedFonts)`
`void`	`setWidth(Integer width)`
`void`	`setZoom(Integer zoom)`
`String`	`toString()`
`PdfConvertOptions`	`unembedFonts(Boolean unembedFonts)`
`PdfConvertOptions`	`width(Integer width)`
`PdfConvertOptions`	`zoom(Integer zoom)`

Methods inherited from class com.groupdocs.cloud.conversion.model.ConvertOptions
addPagesItem, fromPage, getFromPage, getPages, getPagesCount, getWatermarkOptions, pages, pagesCount, setFromPage, setPages, setPagesCount, setWatermarkOptions, watermarkOptions

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- PdfConvertOptions
```
public PdfConvertOptions()
```

Method Detail

width

public PdfConvertOptions width(Integer width)

getWidth
```
public Integer getWidth()
```
Desired page width in pixels after conversion

Returns:

width

setWidth

public void setWidth(Integer width)

height

public PdfConvertOptions height(Integer height)

getHeight
```
public Integer getHeight()
```
Desired page height in pixels after conversion

Returns:

height

setHeight

public void setHeight(Integer height)

dpi

public PdfConvertOptions dpi(Integer dpi)

getDpi
```
public Integer getDpi()
```
Desired page DPI after conversion. The default resolution is: 96dpi

Returns:

dpi

setDpi
```
public void setDpi(Integer dpi)
```

password

public PdfConvertOptions password(String password)

getPassword
```
public String getPassword()
```
Set this property if you want to protect the converted document with a password

Returns:

password

setPassword

public void setPassword(String password)

marginTop

public PdfConvertOptions marginTop(Integer marginTop)

getMarginTop
```
public Integer getMarginTop()
```
Desired page top margin in pixels after conversion

Returns:

marginTop

setMarginTop

public void setMarginTop(Integer marginTop)

marginBottom

public PdfConvertOptions marginBottom(Integer marginBottom)

getMarginBottom
```
public Integer getMarginBottom()
```
Desired page bottom margin in pixels after conversion

Returns:

marginBottom

setMarginBottom

public void setMarginBottom(Integer marginBottom)

marginLeft

public PdfConvertOptions marginLeft(Integer marginLeft)

getMarginLeft
```
public Integer getMarginLeft()
```
Desired page left margin in pixels after conversion

Returns:

marginLeft

setMarginLeft

public void setMarginLeft(Integer marginLeft)

marginRight

public PdfConvertOptions marginRight(Integer marginRight)

getMarginRight
```
public Integer getMarginRight()
```
Desired page right margin in pixels after conversion

Returns:

marginRight

setMarginRight

public void setMarginRight(Integer marginRight)

pdfFormat

public PdfConvertOptions pdfFormat(PdfConvertOptions.PdfFormatEnum pdfFormat)

getPdfFormat
```
public PdfConvertOptions.PdfFormatEnum getPdfFormat()
```
Set the pdf format of the converted document.

Returns:

pdfFormat

setPdfFormat

public void setPdfFormat(PdfConvertOptions.PdfFormatEnum pdfFormat)

removePdfaCompliance

public PdfConvertOptions removePdfaCompliance(Boolean removePdfaCompliance)

getRemovePdfaCompliance
```
public Boolean getRemovePdfaCompliance()
```
Remove Pdf-A Compliance

Returns:

removePdfaCompliance

setRemovePdfaCompliance

public void setRemovePdfaCompliance(Boolean removePdfaCompliance)

zoom

public PdfConvertOptions zoom(Integer zoom)

getZoom
```
public Integer getZoom()
```
Specifies the zoom level in percentage. Default is 100.

Returns:

zoom

setZoom
```
public void setZoom(Integer zoom)
```

linearize

public PdfConvertOptions linearize(Boolean linearize)

getLinearize
```
public Boolean getLinearize()
```
Linearize PDF Document for the Web

Returns:

linearize

setLinearize

public void setLinearize(Boolean linearize)

linkDuplicateStreams

public PdfConvertOptions linkDuplicateStreams(Boolean linkDuplicateStreams)

getLinkDuplicateStreams
```
public Boolean getLinkDuplicateStreams()
```
Link duplicate streams

Returns:

linkDuplicateStreams

setLinkDuplicateStreams

public void setLinkDuplicateStreams(Boolean linkDuplicateStreams)

removeUnusedObjects

public PdfConvertOptions removeUnusedObjects(Boolean removeUnusedObjects)

getRemoveUnusedObjects
```
public Boolean getRemoveUnusedObjects()
```
Remove unused objects

Returns:

removeUnusedObjects

setRemoveUnusedObjects

public void setRemoveUnusedObjects(Boolean removeUnusedObjects)

removeUnusedStreams

public PdfConvertOptions removeUnusedStreams(Boolean removeUnusedStreams)

getRemoveUnusedStreams
```
public Boolean getRemoveUnusedStreams()
```
Remove unused streams

Returns:

removeUnusedStreams

setRemoveUnusedStreams

public void setRemoveUnusedStreams(Boolean removeUnusedStreams)

compressImages

public PdfConvertOptions compressImages(Boolean compressImages)

getCompressImages
```
public Boolean getCompressImages()
```
If CompressImages set to true, all images in the document are recompressed. The compression is defined by the ImageQuality property.

Returns:

compressImages

setCompressImages

public void setCompressImages(Boolean compressImages)

imageQuality

public PdfConvertOptions imageQuality(Integer imageQuality)

getImageQuality
```
public Integer getImageQuality()
```
Value in percent where 100% is unchanged quality and image size. To decrease the image size, use ImageQuality less than 100

Returns:

imageQuality

setImageQuality

public void setImageQuality(Integer imageQuality)

unembedFonts

public PdfConvertOptions unembedFonts(Boolean unembedFonts)

getUnembedFonts
```
public Boolean getUnembedFonts()
```
Make fonts not embedded if set to true

Returns:

unembedFonts

setUnembedFonts

public void setUnembedFonts(Boolean unembedFonts)

grayscale

public PdfConvertOptions grayscale(Boolean grayscale)

getGrayscale
```
public Boolean getGrayscale()
```
Convert a PDF from RGB colorspace to Grayscale

Returns:

grayscale

setGrayscale

public void setGrayscale(Boolean grayscale)

centerWindow

public PdfConvertOptions centerWindow(Boolean centerWindow)

getCenterWindow
```
public Boolean getCenterWindow()
```
Specify whether position of the document's window will be centered on the screen. Default: false.

Returns:

centerWindow

setCenterWindow

public void setCenterWindow(Boolean centerWindow)

direction

public PdfConvertOptions direction(PdfConvertOptions.DirectionEnum direction)

getDirection
```
public PdfConvertOptions.DirectionEnum getDirection()
```
Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R.

Returns:

direction

setDirection

public void setDirection(PdfConvertOptions.DirectionEnum direction)

displayDocTitle

public PdfConvertOptions displayDocTitle(Boolean displayDocTitle)

getDisplayDocTitle
```
public Boolean getDisplayDocTitle()
```
Specifying whether document's window title bar should display document title. Default: false.

Returns:

displayDocTitle

setDisplayDocTitle

public void setDisplayDocTitle(Boolean displayDocTitle)

fitWindow

public PdfConvertOptions fitWindow(Boolean fitWindow)

getFitWindow
```
public Boolean getFitWindow()
```
Specify whether document window must be resized to fit the first displayed page. Default: false.

Returns:

fitWindow

setFitWindow

public void setFitWindow(Boolean fitWindow)

hideMenuBar

public PdfConvertOptions hideMenuBar(Boolean hideMenuBar)

getHideMenuBar
```
public Boolean getHideMenuBar()
```
Specify whether menu bar should be hidden when document is active. Default: false.

Returns:

hideMenuBar

setHideMenuBar

public void setHideMenuBar(Boolean hideMenuBar)

hideToolBar

public PdfConvertOptions hideToolBar(Boolean hideToolBar)

getHideToolBar
```
public Boolean getHideToolBar()
```
Specifying whether toolbar should be hidden when document is active. Default: false.

Returns:

hideToolBar

setHideToolBar

public void setHideToolBar(Boolean hideToolBar)

hideWindowUI

public PdfConvertOptions hideWindowUI(Boolean hideWindowUI)

getHideWindowUI
```
public Boolean getHideWindowUI()
```
Specify whether user interface elements should be hidden when document is active. Default: false.

Returns:

hideWindowUI

setHideWindowUI

public void setHideWindowUI(Boolean hideWindowUI)

nonFullScreenPageMode

public PdfConvertOptions nonFullScreenPageMode(PdfConvertOptions.NonFullScreenPageModeEnum nonFullScreenPageMode)

getNonFullScreenPageMode
```
public PdfConvertOptions.NonFullScreenPageModeEnum getNonFullScreenPageMode()
```
Sets page mode, specifying how to display the document on exiting full-screen mode.

Returns:

nonFullScreenPageMode

setNonFullScreenPageMode

public void setNonFullScreenPageMode(PdfConvertOptions.NonFullScreenPageModeEnum nonFullScreenPageMode)

pageLayout

public PdfConvertOptions pageLayout(PdfConvertOptions.PageLayoutEnum pageLayout)

getPageLayout
```
public PdfConvertOptions.PageLayoutEnum getPageLayout()
```
Sets page layout which shall be used when the document is opened.

Returns:

pageLayout

setPageLayout

public void setPageLayout(PdfConvertOptions.PageLayoutEnum pageLayout)

pageMode

public PdfConvertOptions pageMode(PdfConvertOptions.PageModeEnum pageMode)

getPageMode
```
public PdfConvertOptions.PageModeEnum getPageMode()
```
Sets page mode, specifying how document should be displayed when opened.

Returns:

pageMode

setPageMode

public void setPageMode(PdfConvertOptions.PageModeEnum pageMode)

rotate

public PdfConvertOptions rotate(PdfConvertOptions.RotateEnum rotate)

getRotate

public PdfConvertOptions.RotateEnum getRotate()

Rotate page

Returns:: rotate

setRotate

public void setRotate(PdfConvertOptions.RotateEnum rotate)

pageSize

public PdfConvertOptions pageSize(PdfConvertOptions.PageSizeEnum pageSize)

getPageSize

public PdfConvertOptions.PageSizeEnum getPageSize()

Specifies page size

Returns:: pageSize

setPageSize

public void setPageSize(PdfConvertOptions.PageSizeEnum pageSize)

pageOrientation

public PdfConvertOptions pageOrientation(PdfConvertOptions.PageOrientationEnum pageOrientation)

getPageOrientation

public PdfConvertOptions.PageOrientationEnum getPageOrientation()

Specifies page orientation

Returns:: pageOrientation

setPageOrientation

public void setPageOrientation(PdfConvertOptions.PageOrientationEnum pageOrientation)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class ConvertOptions

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class ConvertOptions

toString
```
public String toString()
```
Overrides:

toString in class ConvertOptions

Class PdfConvertOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.groupdocs.cloud.conversion.model.ConvertOptions

Methods inherited from class java.lang.Object

Constructor Detail

PdfConvertOptions

Method Detail

width

getWidth

setWidth

height

getHeight

setHeight

dpi

getDpi

setDpi

password

getPassword

setPassword

marginTop

getMarginTop

setMarginTop

marginBottom

getMarginBottom

setMarginBottom

marginLeft

getMarginLeft

setMarginLeft

marginRight

getMarginRight

setMarginRight

pdfFormat

getPdfFormat

setPdfFormat

removePdfaCompliance

getRemovePdfaCompliance

setRemovePdfaCompliance

zoom

getZoom

setZoom

linearize

getLinearize

setLinearize

linkDuplicateStreams

getLinkDuplicateStreams

setLinkDuplicateStreams

removeUnusedObjects

getRemoveUnusedObjects

setRemoveUnusedObjects

removeUnusedStreams

getRemoveUnusedStreams

setRemoveUnusedStreams

compressImages

getCompressImages

setCompressImages

imageQuality

getImageQuality

setImageQuality

unembedFonts

getUnembedFonts

setUnembedFonts

grayscale

getGrayscale

setGrayscale

centerWindow

getCenterWindow

setCenterWindow

direction

getDirection

setDirection

displayDocTitle

getDisplayDocTitle

setDisplayDocTitle

fitWindow

getFitWindow

setFitWindow

hideMenuBar

getHideMenuBar