com.aspose.diagram
Class PdfSaveOptions

java.lang.Object
  extended by SaveOptions
      extended by RenderingSaveOptions
          extended by com.aspose.diagram.PdfSaveOptions

public class PdfSaveOptions 
extends RenderingSaveOptions

Allows to specify additional options when rendering diagram pages to PDF.


Constructor Summary
PdfSaveOptions()
           Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.
 
Property Getters/Setters Summary
intgetCompliance()
voidsetCompliance(int)
           Desired conformance level for generated PDF document. Default is PdfCompliance.PDF_15. The value of the property is PdfCompliance integer constant.
java.lang.StringgetDefaultFont()→ inherited from SaveOptions
voidsetDefaultFont(java.lang.String)
           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.
intgetEmfRenderSetting()→ inherited from RenderingSaveOptions
voidsetEmfRenderSetting(int)
           Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
PdfEncryptionDetailsgetEncryptionDetails()
voidsetEncryptionDetails(PdfEncryptionDetails)
           Gets or sets a encryption details. If not set, then no encryption will be performed.
booleangetEnlargePage()→ inherited from RenderingSaveOptions
voidsetEnlargePage(boolean)
           Specifies whether enlarge page .
booleangetExportGuideShapes()→ inherited from RenderingSaveOptions
voidsetExportGuideShapes(boolean)
           Defines whether need exporting the guide shapes or not.
booleangetExportHiddenPage()
voidsetExportHiddenPage(boolean)
           Defines whether need exporting the hidden page or not.
intgetHorizontalResolution()
voidsetHorizontalResolution(int)
           Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images.
booleanisExportComments()→ inherited from RenderingSaveOptions
voidsetExportComments(boolean)
           Defines whether need exporting the comments or not.
intgetJpegQuality()
voidsetJpegQuality(int)
           Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
intgetPageCount()
voidsetPageCount(int)
           Gets or sets the number of pages to render in PDF. Default is MaxValue which means all pages of the diagram will be rendered.
intgetPageIndex()
voidsetPageIndex(int)
           Gets or sets the 0-based index of the first page to render. Default is 0.
IPageSavingCallbackgetPageSavingCallback()
voidsetPageSavingCallback(IPageSavingCallback)
           Control/Indicate progress of page saving process.
PageSizegetPageSize()→ inherited from RenderingSaveOptions
voidsetPageSize(PageSize)
           Gets or sets the page size for the generated images. Can be PageSize or null.
booleangetSaveForegroundPagesOnly()
voidsetSaveForegroundPagesOnly(boolean)
           Specifies whether all pages will be saved in image or only foreground.
intgetSaveFormat()
voidsetSaveFormat(int)
           Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be SaveFileFormat only. The value of the property is SaveFileFormat integer constant.
ShapeCollectiongetShapes()→ inherited from RenderingSaveOptions
voidsetShapes(ShapeCollection)
           Gets or sets shapes to render. Default count is 0.
booleangetSplitMultiPages()
voidsetSplitMultiPages(boolean)
           Defines whether split diagram to multi pages according to page's setting.
intgetTextCompression()
voidsetTextCompression(int)
           Specifies compression type to be used for all content streams except images. Default is PdfTextCompression.FLATE. The value of the property is PdfTextCompression integer constant.
intgetVerticalResolution()
voidsetVerticalResolution(int)
           Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image.
IWarningCallbackgetWarningCallback()
voidsetWarningCallback(IWarningCallback)
           Gets or sets warning callback.
 

Constructor Detail

PdfSaveOptions

public PdfSaveOptions()
               throws java.lang.Exception
Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.

Property Getters/Setters Detail

getPageCount/setPageCount

public int getPageCount() / public void setPageCount(int value)
Gets or sets the number of pages to render in PDF. Default is MaxValue which means all pages of the diagram will be rendered.

getPageIndex/setPageIndex

public int getPageIndex() / public void setPageIndex(int value)
Gets or sets the 0-based index of the first page to render. Default is 0.

getSaveFormat/setSaveFormat

public int getSaveFormat() / public void setSaveFormat(int value)
Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be SaveFileFormat only. The value of the property is SaveFileFormat integer constant.

getSaveForegroundPagesOnly/setSaveForegroundPagesOnly

public boolean getSaveForegroundPagesOnly() / public void setSaveForegroundPagesOnly(boolean value)
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.

getCompliance/setCompliance

public int getCompliance() / public void setCompliance(int value)
Desired conformance level for generated PDF document. Default is PdfCompliance.PDF_15. The value of the property is PdfCompliance integer constant.

getEncryptionDetails/setEncryptionDetails

public PdfEncryptionDetails getEncryptionDetails() / public void setEncryptionDetails(PdfEncryptionDetails value)
Gets or sets a encryption details. If not set, then no encryption will be performed.

getWarningCallback/setWarningCallback

public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
Gets or sets warning callback.

getPageSavingCallback/setPageSavingCallback

public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value)
Control/Indicate progress of page saving process.

getJpegQuality/setJpegQuality

public int getJpegQuality() / public void setJpegQuality(int value)
Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.

getHorizontalResolution/setHorizontalResolution

public int getHorizontalResolution() / public void setHorizontalResolution(int value)
Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images. The default value is 96.

getVerticalResolution/setVerticalResolution

public int getVerticalResolution() / public void setVerticalResolution(int value)
Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image. The default value is 96.

getSplitMultiPages/setSplitMultiPages

public boolean getSplitMultiPages() / public void setSplitMultiPages(boolean value)
Defines whether split diagram to multi pages according to page's setting. Default value is false.

getExportHiddenPage/setExportHiddenPage

public boolean getExportHiddenPage() / public void setExportHiddenPage(boolean value)
Defines whether need exporting the hidden page or not. Default value is true.

getTextCompression/setTextCompression

public int getTextCompression() / public void setTextCompression(int value)
Specifies compression type to be used for all content streams except images. Default is PdfTextCompression.FLATE. The value of the property is PdfTextCompression integer constant.

getPageSize/setPageSize

→ inherited from RenderingSaveOptions
public PageSize getPageSize() / public void setPageSize(PageSize value)
Gets or sets 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.

getShapes/setShapes

→ inherited from RenderingSaveOptions
public ShapeCollection getShapes() / public void setShapes(ShapeCollection value)
Gets or sets shapes to render. Default count is 0.

getExportGuideShapes/setExportGuideShapes

→ inherited from RenderingSaveOptions
public boolean getExportGuideShapes() / public void setExportGuideShapes(boolean value)
Defines whether need exporting the guide shapes or not. Default value is true.

isExportComments/setExportComments

→ inherited from RenderingSaveOptions
public boolean isExportComments() / public void setExportComments(boolean value)
Defines whether need exporting the comments or not. Default value is false.

getEnlargePage/setEnlargePage

→ inherited from RenderingSaveOptions
public boolean getEnlargePage() / public void setEnlargePage(boolean value)
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.

getEmfRenderSetting/setEmfRenderSetting

→ inherited from RenderingSaveOptions
public int getEmfRenderSetting() / public void setEmfRenderSetting(int value)
Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant. 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"/>.

getDefaultFont/setDefaultFont

→ inherited from SaveOptions
public java.lang.String getDefaultFont() / public void setDefaultFont(java.lang.String value)
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.

See Also:
          Aspose.Diagram Documentation - the home page for the Aspose.Diagram Product Documentation.
          Aspose.Diagram Support Forum - our preferred method of support.