RasterizationOptions
Inheritance: java.lang.Object
public class RasterizationOptions
Provides options for converting files into PDF.
Learn more
- More details about saving document as a rasterized PDF: Save in rasterized PDF
- More details about rasterization options: Select specific pages for rasterized PDF
Constructors
| Constructor | Description |
|---|---|
| RasterizationOptions() | Initializes a new instance. |
Methods
| Method | Description |
|---|---|
| getEnabled() | Gets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. |
| setEnabled(boolean value) | Sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. |
| getPageIndex() | Gets the index of the first page (0-based) to convert into PDF. |
| setPageIndex(int value) | Sets the index of the first page (0-based) to convert into PDF. |
| isStartPageIndexSet() | Gets a value indicating whether the PageIndex property was changed (set) after its initialization. |
| getPageCount() | Gets the number of pages to be converted into PDF. |
| setPageCount(int value) | Sets the number of pages to be converted into PDF. |
| isPageCountSet() | Gets a value indicating whether the PageCount property was changed (set) after its initialization. |
| getCompliance() | Gets the PDF Compliance level. |
| setCompliance(PdfComplianceLevel value) | Sets the PDF Compliance level. |
| hasAdvancedOptions() | Gets an indicator, which is true if advanced rasterization options are set. |
| addAdvancedOption(AdvancedRasterizationOptions optionType) | You can use this method to register an advanced rasterization option to apply. |
| addAdvancedOption(AdvancedRasterizationOptions optionType, HashMap<String,String> parameters) | You can use this method to register an advanced rasterization option to apply. |
RasterizationOptions()
public RasterizationOptions()
Initializes a new instance.
getEnabled()
public final boolean getEnabled()
Gets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization.
Returns: boolean - A value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization.
setEnabled(boolean value)
public final void setEnabled(boolean value)
Sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value indicating whether all pages in the document need to be converted to images and put in a single PDF file. TRUE by default, set to FALSE in order to avoid rasterization. |
getPageIndex()
public final int getPageIndex()
Gets the index of the first page (0-based) to convert into PDF.
Returns: int - The index of the first page (0-based) to convert into PDF.
setPageIndex(int value)
public final void setPageIndex(int value)
Sets the index of the first page (0-based) to convert into PDF.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The index of the first page (0-based) to convert into PDF. |
isStartPageIndexSet()
public final boolean isStartPageIndexSet()
Gets a value indicating whether the PageIndex property was changed (set) after its initialization.
Returns: boolean - A value indicating whether the PageIndex property was changed (set) after its initialization.
getPageCount()
public final int getPageCount()
Gets the number of pages to be converted into PDF.
Returns: int - The number of pages to be converted into PDF.
setPageCount(int value)
public final void setPageCount(int value)
Sets the number of pages to be converted into PDF.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The number of pages to be converted into PDF. |
isPageCountSet()
public final boolean isPageCountSet()
Gets a value indicating whether the PageCount property was changed (set) after its initialization.
Returns: boolean - A value indicating whether the PageCount property was changed (set) after its initialization.
getCompliance()
public final PdfComplianceLevel getCompliance()
Gets the PDF Compliance level.
Returns: PdfComplianceLevel - The PDF Compliance level.
setCompliance(PdfComplianceLevel value)
public final void setCompliance(PdfComplianceLevel value)
Sets the PDF Compliance level.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PdfComplianceLevel | The PDF Compliance level. |
hasAdvancedOptions()
public final boolean hasAdvancedOptions()
Gets an indicator, which is true if advanced rasterization options are set.
Returns: boolean - An indicator, which is true if advanced rasterization options are set.
addAdvancedOption(AdvancedRasterizationOptions optionType)
public final void addAdvancedOption(AdvancedRasterizationOptions optionType)
You can use this method to register an advanced rasterization option to apply.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| optionType | AdvancedRasterizationOptions | Provides information about the selected effect type (grayscale, border, etc.) |
addAdvancedOption(AdvancedRasterizationOptions optionType, HashMap<String,String> parameters)
public final void addAdvancedOption(AdvancedRasterizationOptions optionType, HashMap<String,String> parameters)
You can use this method to register an advanced rasterization option to apply.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| optionType | AdvancedRasterizationOptions | Provides information about the selected effect type (grayscale, border, etc.) |
| parameters | java.util.HashMap<java.lang.String,java.lang.String> | Parameters for the given effect, such as rotation angle |