PdfConvertOptions
Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions
All Implemented Interfaces: java.io.Serializable, com.groupdocs.conversion.options.convert.IPageMarginConvertOptions, com.groupdocs.conversion.options.convert.IPageSizeConvertOptions, com.groupdocs.conversion.options.convert.IPageOrientationConvertOptions
public class PdfConvertOptions extends CommonConvertOptions<PdfFileType> implements Serializable, IPageMarginConvertOptions, IPageSizeConvertOptions, IPageOrientationConvertOptions
Options for conversion to Pdf file type.
Constructors
| Constructor | Description |
|---|---|
| PdfConvertOptions() | Initializes new instance of PdfConvertOptions class. |
Methods
| Method | Description |
|---|---|
| getWidth() | Desired page width in pixels after conversion. |
| setWidth(int value) | Desired page width in pixels after conversion. |
| getHeight() | Desired page height in pixels after conversion. |
| setHeight(int value) | Desired page height in pixels after conversion. |
| getDpi() | Desired page DPI after conversion. |
| setDpi(double value) | Desired page DPI after conversion. |
| getPassword() | Set this property if you want to protect the converted document with a password. |
| setPassword(String value) | Set this property if you want to protect the converted document with a password. |
| getMarginTop() | Desired page top margin in pixels after conversion. |
| setMarginTop(int value) | Desired page top margin in pixels after conversion. |
| getMarginBottom() | Desired page bottom margin in pixels after conversion. |
| setMarginBottom(int value) | Desired page bottom margin in pixels after conversion. |
| getMarginLeft() | Desired page left margin in pixels after conversion. |
| setMarginLeft(int value) | Desired page left margin in pixels after conversion. |
| getMarginRight() | Desired page right margin in pixels after conversion. |
| setMarginRight(int value) | Desired page right margin in pixels after conversion. |
| getPdfOptions() | Pdf specific convert options |
| setPdfOptions(PdfOptions value) | Pdf specific convert options |
| getRotate() | Page rotation |
| setRotate(Rotation value) | Page rotation |
| getPageOrientation() | |
| setPageOrientation(PageOrientation pageOrientation) | |
| getPageSize() | |
| setPageSize(PageSize pageSize) | |
| getPageWidth() | |
| setPageWidth(float pageWidth) | |
| getPageHeight() | |
| setPageHeight(float pageHeight) |
PdfConvertOptions()
public PdfConvertOptions()
Initializes new instance of PdfConvertOptions class.
getWidth()
public final int getWidth()
Desired page width in pixels after conversion.
Returns: int
setWidth(int value)
public final void setWidth(int value)
Desired page width in pixels after conversion.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getHeight()
public final int getHeight()
Desired page height in pixels after conversion.
Returns: int
setHeight(int value)
public final void setHeight(int value)
Desired page height in pixels after conversion.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getDpi()
public final double getDpi()
Desired page DPI after conversion. The default resolution is: 96 dpi.
Returns: double
setDpi(double value)
public final void setDpi(double value)
Desired page DPI after conversion. The default resolution is: 96 dpi.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
getPassword()
public final String getPassword()
Set this property if you want to protect the converted document with a password.
Returns: java.lang.String
setPassword(String value)
public final void setPassword(String value)
Set this property if you want to protect the converted document with a password.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getMarginTop()
public final int getMarginTop()
Desired page top margin in pixels after conversion.
Returns: int
setMarginTop(int value)
public final void setMarginTop(int value)
Desired page top margin in pixels after conversion.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getMarginBottom()
public final int getMarginBottom()
Desired page bottom margin in pixels after conversion.
Returns: int
setMarginBottom(int value)
public final void setMarginBottom(int value)
Desired page bottom margin in pixels after conversion.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getMarginLeft()
public final int getMarginLeft()
Desired page left margin in pixels after conversion.
Returns: int
setMarginLeft(int value)
public final void setMarginLeft(int value)
Desired page left margin in pixels after conversion.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getMarginRight()
public final int getMarginRight()
Desired page right margin in pixels after conversion.
Returns: int
setMarginRight(int value)
public final void setMarginRight(int value)
Desired page right margin in pixels after conversion.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getPdfOptions()
public final PdfOptions getPdfOptions()
Pdf specific convert options
Returns: PdfOptions
setPdfOptions(PdfOptions value)
public final void setPdfOptions(PdfOptions value)
Pdf specific convert options
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PdfOptions |
getRotate()
public final Rotation getRotate()
Page rotation
Returns: Rotation
setRotate(Rotation value)
public final void setRotate(Rotation value)
Page rotation
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Rotation |
getPageOrientation()
public PageOrientation getPageOrientation()
Gets page orientation after conversion
Returns: PageOrientation
setPageOrientation(PageOrientation pageOrientation)
public void setPageOrientation(PageOrientation pageOrientation)
Sets desired page orientation after conversion
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageOrientation | PageOrientation |
getPageSize()
public PageSize getPageSize()
Gets desired page size after conversion
Returns: PageSize
setPageSize(PageSize pageSize)
public void setPageSize(PageSize pageSize)
Set desired page size after conversion
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageSize | PageSize |
getPageWidth()
public float getPageWidth()
Specified page width in points if is set to PageSize.Custom
Returns: float
setPageWidth(float pageWidth)
public void setPageWidth(float pageWidth)
Set desired page width
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageWidth | float |
getPageHeight()
public float getPageHeight()
Specified page height in points if is set to PageSize.Custom
Returns: float
setPageHeight(float pageHeight)
public void setPageHeight(float pageHeight)
Set desired page height
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageHeight | float |