PdfSaveOptions
Inheritance: java.lang.Object, com.aspose.diagram.SaveOptions, com.aspose.diagram.RenderingSaveOptions
public class PdfSaveOptions extends RenderingSaveOptions
Allows to specify additional options when rendering diagram pages to PDF.
Constructors
| Constructor | Description |
|---|---|
| PdfSaveOptions() | Initializes a new instance of this class that can be used to save a document in the Aspose.Diagram.SaveFileFormat format. |
Methods
| Method | Description |
|---|---|
| createSaveOptions(int saveFormat) | Creates a save options object of a class suitable for the specified save format. |
| equals(Object arg0) | |
| getClass() | |
| getCompliance() | Desired conformance level for generated PDF document. |
| getDefaultFont() | When characters in the diagram are unicode and not be set with correct font value or the font is not installed locally, they may appear as block in pdf, image or XPS. |
| getEmfRenderSetting() | Setting for rendering Emf metafile. |
| getEncryptionDetails() | a encryption details. |
| getEnlargePage() | Specifies whether enlarge page . |
| getExportGuideShapes() | Defines whether need exporting the guide shapes or not. |
| getExportHiddenPage() | Defines whether need exporting the hidden page or not. |
| getHorizontalResolution() | the horizontal resolution for generated images, in dots per inch. |
| getJpegQuality() | Specifies the quality of JPEG compression for images (if JPEG compression is used). |
| getPageCount() | the number of pages to render in PDF. |
| getPageIndex() | the 0-based index of the first page to render. |
| getPageSavingCallback() | Control/Indicate progress of page saving process. |
| getPageSize() | the page size for the generated images. |
| getSaveForegroundPagesOnly() | Specifies whether all pages will be saved in image or only foreground. |
| getSaveFormat() | Specifies the format in which the rendered diagram pages will be saved if this save options object is used. |
| getShapes() | shapes to render. |
| getSplitMultiPages() | Defines whether split diagram to multi pages according to page’s setting. |
| getTextCompression() | Specifies compression type to be used for all content streams except images. |
| getVerticalResolution() | the vertical resolution for generated images, in dots per inch. |
| getWarningCallback() | warning callback. |
| hashCode() | |
| isExportComments() | Defines whether need exporting the comments or not. |
| notify() | |
| notifyAll() | |
| setCompliance(int value) | For the description of this property, please see getCompliance() |
| setDefaultFont(String value) | For the description of this property, please see getDefaultFont() |
| setEmfRenderSetting(int value) | For the description of this property, please see getEmfRenderSetting() |
| setEncryptionDetails(PdfEncryptionDetails value) | For the description of this property, please see getEncryptionDetails() |
| setEnlargePage(boolean value) | For the description of this property, please see getEnlargePage() |
| setExportComments(boolean value) | For the description of this property, please see isExportComments() |
| setExportGuideShapes(boolean value) | For the description of this property, please see getExportGuideShapes() |
| setExportHiddenPage(boolean value) | For the description of this property, please see getExportHiddenPage() |
| setHorizontalResolution(int value) | For the description of this property, please see getHorizontalResolution() |
| setJpegQuality(int value) | For the description of this property, please see getJpegQuality() |
| setPageCount(int value) | For the description of this property, please see getPageCount() |
| setPageIndex(int value) | For the description of this property, please see getPageIndex() |
| setPageSavingCallback(IPageSavingCallback value) | For the description of this property, please see getPageSavingCallback() |
| setPageSize(PageSize value) | For the description of this property, please see getPageSize() |
| setSaveForegroundPagesOnly(boolean value) | For the description of this property, please see getSaveForegroundPagesOnly() |
| setSaveFormat(int value) | For the description of this property, please see getSaveFormat() |
| setShapes(ShapeCollection value) | For the description of this property, please see getShapes() |
| setSplitMultiPages(boolean value) | For the description of this property, please see getSplitMultiPages() |
| setTextCompression(int value) | For the description of this property, please see getTextCompression() |
| setVerticalResolution(int value) | For the description of this property, please see getVerticalResolution() |
| setWarningCallback(IWarningCallback value) | |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
PdfSaveOptions()
public PdfSaveOptions()
Initializes a new instance of this class that can be used to save a document in the Aspose.Diagram.SaveFileFormat format.
createSaveOptions(int saveFormat)
public static SaveOptions createSaveOptions(int saveFormat)
Creates a save options object of a class suitable for the specified save format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int | The Aspose.Diagram.SaveFileFormat for which to create a save options object. |
Returns: SaveOptions - An object of a class that derives from SaveOptions.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCompliance()
public int getCompliance()
Desired conformance level for generated PDF document. Default is PdfCompliance.PDF_15.
Returns: int
getDefaultFont()
public String getDefaultFont()
When characters in the diagram are unicode and not be set with correct font value or the font is not installed locally, they may appear as block in pdf, image or XPS. Set the DefaultFont such as MingLiu or MS Gothic to show these characters.
Returns: java.lang.String
getEmfRenderSetting()
public int getEmfRenderSetting()
Setting for rendering Emf metafile. EMF metafiles identified as “EMF+ Dual” can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is EmfOnly"/>.
Returns: int
getEncryptionDetails()
public PdfEncryptionDetails getEncryptionDetails()
a encryption details. If not set, then no encryption will be performed.
Returns: PdfEncryptionDetails
getEnlargePage()
public boolean getEnlargePage()
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.
Returns: boolean
getExportGuideShapes()
public boolean getExportGuideShapes()
Defines whether need exporting the guide shapes or not. Default value is true.
Returns: boolean
getExportHiddenPage()
public boolean getExportHiddenPage()
Defines whether need exporting the hidden page or not. Default value is true.
Returns: boolean
getHorizontalResolution()
public int getHorizontalResolution()
the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images. The default value is 96.
Returns: int
getJpegQuality()
public int getJpegQuality()
Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
Returns: int
getPageCount()
public int getPageCount()
the number of pages to render in PDF. Default is MaxValue which means all pages of the diagram will be rendered.
Returns: int
getPageIndex()
public int getPageIndex()
the 0-based index of the first page to render. Default is 0.
Returns: int
getPageSavingCallback()
public IPageSavingCallback getPageSavingCallback()
Control/Indicate progress of page saving process.
Returns: IPageSavingCallback
getPageSize()
public PageSize getPageSize()
the page size for the generated images. Can be PageSize or null. The default value is null. If PageSize is null then page size for generated image is obtained from source diagram.
Returns: PageSize
getSaveForegroundPagesOnly()
public boolean getSaveForegroundPagesOnly()
Specifies whether all pages will be saved in image or only foreground. If true - rendered only foreground pages(with background if present). If false - rendered foreground pages(with background if present) after that empty background pages. Can return true only when PageCount > 1. The default value is false.
Returns: boolean
getSaveFormat()
public int getSaveFormat()
Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be Aspose.Diagram.SaveFileFormat only.
Returns: int
getShapes()
public ShapeCollection getShapes()
shapes to render. Default count is 0.
Returns: ShapeCollection
getSplitMultiPages()
public boolean getSplitMultiPages()
Defines whether split diagram to multi pages according to page’s setting. Default value is false.
Returns: boolean
getTextCompression()
public int getTextCompression()
Specifies compression type to be used for all content streams except images. Default is PdfTextCompression.FLATE.
Returns: int
getVerticalResolution()
public int getVerticalResolution()
the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image. The default value is 96.
Returns: int
getWarningCallback()
public IWarningCallback getWarningCallback()
warning callback.
Returns: IWarningCallback
hashCode()
public native int hashCode()
Returns: int
isExportComments()
public boolean isExportComments()
Defines whether need exporting the comments or not. Default value is false.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setCompliance(int value)
public void setCompliance(int value)
For the description of this property, please see getCompliance()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setDefaultFont(String value)
public void setDefaultFont(String value)
For the description of this property, please see getDefaultFont()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setEmfRenderSetting(int value)
public void setEmfRenderSetting(int value)
For the description of this property, please see getEmfRenderSetting()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setEncryptionDetails(PdfEncryptionDetails value)
public void setEncryptionDetails(PdfEncryptionDetails value)
For the description of this property, please see getEncryptionDetails()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PdfEncryptionDetails |
setEnlargePage(boolean value)
public void setEnlargePage(boolean value)
For the description of this property, please see getEnlargePage()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportComments(boolean value)
public void setExportComments(boolean value)
For the description of this property, please see isExportComments()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportGuideShapes(boolean value)
public void setExportGuideShapes(boolean value)
For the description of this property, please see getExportGuideShapes()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportHiddenPage(boolean value)
public void setExportHiddenPage(boolean value)
For the description of this property, please see getExportHiddenPage()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setHorizontalResolution(int value)
public void setHorizontalResolution(int value)
For the description of this property, please see getHorizontalResolution()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setJpegQuality(int value)
public void setJpegQuality(int value)
For the description of this property, please see getJpegQuality()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPageCount(int value)
public void setPageCount(int value)
For the description of this property, please see getPageCount()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPageIndex(int value)
public void setPageIndex(int value)
For the description of this property, please see getPageIndex()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPageSavingCallback(IPageSavingCallback value)
public void setPageSavingCallback(IPageSavingCallback value)
For the description of this property, please see getPageSavingCallback()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IPageSavingCallback |
setPageSize(PageSize value)
public void setPageSize(PageSize value)
For the description of this property, please see getPageSize()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PageSize |
setSaveForegroundPagesOnly(boolean value)
public void setSaveForegroundPagesOnly(boolean value)
For the description of this property, please see getSaveForegroundPagesOnly()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSaveFormat(int value)
public void setSaveFormat(int value)
For the description of this property, please see getSaveFormat()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setShapes(ShapeCollection value)
public void setShapes(ShapeCollection value)
For the description of this property, please see getShapes()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ShapeCollection |
setSplitMultiPages(boolean value)
public void setSplitMultiPages(boolean value)
For the description of this property, please see getSplitMultiPages()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setTextCompression(int value)
public void setTextCompression(int value)
For the description of this property, please see getTextCompression()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setVerticalResolution(int value)
public void setVerticalResolution(int value)
For the description of this property, please see getVerticalResolution()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setWarningCallback(IWarningCallback value)
public void setWarningCallback(IWarningCallback value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IWarningCallback |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |