com.aspose.diagram

Class 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
java.awt.geom.Rectangle2D.FloatgetArea()
Gets or sets the area of the shapes will be saved .
intgetCompliance()
void
setCompliance(intvalue)
           Desired conformance level for generated PDF document. Default is PdfCompliance.PDF_15. The value of the property is PdfCompliance integer constant.
java.lang.StringgetDefaultFont()
void
setDefaultFont(java.lang.Stringvalue)
           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.
PdfDigitalSignatureDetailsgetDigitalSignatureDetails()
void
           Gets or sets a digital signature details. If not set, then no signing will be performed.
intgetEmfRenderSetting()
void
           Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
PdfEncryptionDetailsgetEncryptionDetails()
void
           Gets or sets a encryption details. If not set, then no encryption will be performed.
booleangetEnlargePage()
void
setEnlargePage(booleanvalue)
           Specifies whether enlarge page .
booleangetExportGuideShapes()
void
setExportGuideShapes(booleanvalue)
           Defines whether need exporting the guide shapes or not.
booleangetExportHiddenPage()
void
setExportHiddenPage(booleanvalue)
           Defines whether need exporting the hidden page or not.
intgetHorizontalResolution()
void
           Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images.
booleanisExportComments()
void
setExportComments(booleanvalue)
           Defines whether need exporting the comments or not.
intgetJpegQuality()
void
setJpegQuality(intvalue)
           Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
intgetPageCount()
void
setPageCount(intvalue)
           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()
void
setPageIndex(intvalue)
           Gets or sets the 0-based index of the first page to render. Default is 0.
IPageSavingCallbackgetPageSavingCallback()
void
           Control/Indicate progress of page saving process.
PageSizegetPageSize()
void
           Gets or sets the page size for the generated images. Can be PageSize or null.
booleangetSaveForegroundPagesOnly()
void
           Specifies whether all pages will be saved in image or only foreground.
intgetSaveFormat()
void
setSaveFormat(intvalue)
           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()
void
           Gets or sets shapes to render. Default count is 0.
booleangetSplitMultiPages()
void
setSplitMultiPages(booleanvalue)
           Defines whether split diagram to multi pages according to page's setting.
intgetTextCompression()
void
           Specifies compression type to be used for all content streams except images. Default is #Error Cref: !:PdfTextCompressionCore.Flate. The value of the property is PdfTextCompression integer constant.
intgetVerticalResolution()
void
           Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image.
IWarningCallbackgetWarningCallback()
void
           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 #Error Cref: !:PdfTextCompressionCore.Flate. The value of the property is PdfTextCompression integer constant.
      • getDigitalSignatureDetails/setDigitalSignatureDetails

        public PdfDigitalSignatureDetails getDigitalSignatureDetails() / public void setDigitalSignatureDetails(PdfDigitalSignatureDetails value)
        
        Gets or sets a digital signature details. If not set, then no signing will be performed.
      • getPageSize/setPageSize

        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

        public ShapeCollection getShapes() / public void setShapes(ShapeCollection value)
        
        Gets or sets shapes to render. Default count is 0.
      • getArea

        public java.awt.geom.Rectangle2D.Float getArea()
        
        Gets or sets the area of the shapes will be saved . This property has effect only when saving to raster image formats.
      • getExportGuideShapes/setExportGuideShapes

        public boolean getExportGuideShapes() / public void setExportGuideShapes(boolean value)
        
        Defines whether need exporting the guide shapes or not. Default value is true.
      • isExportComments/setExportComments

        public boolean isExportComments() / public void setExportComments(boolean value)
        
        Defines whether need exporting the comments or not. Default value is false.
      • getEnlargePage/setEnlargePage

        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

        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 #Error Cref: !:EmfRenderSetting.EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is #Error Cref: !:EmfRenderSetting.EmfOnly.
      • getDefaultFont/setDefaultFont

        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.