com.aspose.slides

Interfaces

Classes

Exceptions

Skip navigation links
com.aspose.slides

Interface IPdfOptions

  • All Superinterfaces:
    ISaveOptions
    All Known Implementing Classes:
    PdfOptions

    public interface IPdfOptions
extends ISaveOptions

    Provides options that control how a presentation is saved in Pdf format.

    • Method Detail

      • getBestImagesCompressionRatio

        boolean getBestImagesCompressionRatio()

        Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to bool.True, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document.

        Best image compression ratio selection is computationally expensive and takes an additional amount of RAM, and this option is bool.False by default.

        Default is bool.False.

      • setBestImagesCompressionRatio

        void setBestImagesCompressionRatio(boolean value)

        Indicates if the most effective compression (instead of the default one) for each image must be selected automatically. If set to bool.True, for every image in presentation the most appropriate compression algorithm will be chosen, what will lead to the smaller size of the resulting PDF document.

        Best image compression ratio selection is computationally expensive and takes an additional amount of RAM, and this option is bool.False by default.

        Default is bool.False.

      • getEmbedTrueTypeFontsForASCII

        boolean getEmbedTrueTypeFontsForASCII()

        True to embed true type fonts for ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Read/write boolean.

        Default is <b>true</b>.

      • setEmbedTrueTypeFontsForASCII

        void setEmbedTrueTypeFontsForASCII(boolean value)

        True to embed true type fonts for ASCII characters 32-127. Fonts for character codes greater than 127 are always embedded. Read/write boolean.

        Default is <b>true</b>.

      • getShowHiddenSlides

        boolean getShowHiddenSlides()

        Specifies whether the generated document should include hidden slides or not. Default is false.

      • setShowHiddenSlides

        void setShowHiddenSlides(boolean value)

        Specifies whether the generated document should include hidden slides or not. Default is false.

      • getAdditionalCommonFontFamilies

        java.lang.String[] getAdditionalCommonFontFamilies()

        Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common. Read/write String[].

      • setAdditionalCommonFontFamilies

        void setAdditionalCommonFontFamilies(java.lang.String[] value)

        Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common. Read/write String[].

      • getEmbedFullFonts

        boolean getEmbedFullFonts()

        Determines if all characters of font should be embedded or only used subset. Read/write boolean.

        Default is <b>false</b>.

      • setEmbedFullFonts

        void setEmbedFullFonts(boolean value)

        Determines if all characters of font should be embedded or only used subset. Read/write boolean.

        Default is <b>false</b>.

      • getJpegQuality

        byte getJpegQuality()

        Returns or sets a value determining the quality of the JPEG images inside PDF document. Read/write byte.

        <p>Has effect only when a document contains JPEG images.</p> <p>Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.</p> <p>The default value is <b>100</b>.</p>

      • setJpegQuality

        void setJpegQuality(byte value)

        Returns or sets a value determining the quality of the JPEG images inside PDF document. Read/write byte.

        <p>Has effect only when a document contains JPEG images.</p> <p>Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.</p> <p>The default value is <b>100</b>.</p>

      • getPassword

        java.lang.String getPassword()

        Setting user password to protect the PDF document. Read/write String.

      • setPassword

        void setPassword(java.lang.String value)

        Setting user password to protect the PDF document. Read/write String.

      • getAccessPermissions

        int getAccessPermissions()

        Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions. 

         
         PdfOptions pdfOptions = new PdfOptions();
 pdfOptions.setPassword("my_password");
 pdfOptions.setAccessPermissions(PdfAccessPermissions.PrintDocument | PdfAccessPermissions.HighQualityPrint);
 Presentation presentation = new Presentation();
 try
 {
     presentation.save(pdfFilePath, SaveFormat.Pdf, pdfOptions);
 } finally {
     if (presentation != null) presentation.dispose();
 }

      • setAccessPermissions

        void setAccessPermissions(int value)

        Contains a set of flags specifying which access permissions should be granted when the document is opened with user access. See PdfAccessPermissions. 

         
         PdfOptions pdfOptions = new PdfOptions();
 pdfOptions.setPassword("my_password");
 pdfOptions.setAccessPermissions(PdfAccessPermissions.PrintDocument | PdfAccessPermissions.HighQualityPrint);
 Presentation presentation = new Presentation();
 try
 {
     presentation.save(pdfFilePath, SaveFormat.Pdf, pdfOptions);
 } finally {
     if (presentation != null) presentation.dispose();
 }

      • getSaveMetafilesAsPng

        boolean getSaveMetafilesAsPng()

        True to convert all metafiles used in a presentation to the PNG images. Read/write boolean.

        Default is <b>true</b>. Pdf document can contain vector graphics and raster images. If SaveMetafilesAsPng is set to true then source Metafile image is converted to Png format and saved to Pdf as a raster image. If SaveMetafilesAsPng is set to false then source Metafile is converted to Pdf vector graphics. Each approach has advantages and disadvantages.For example, if Metafile is converted to PNG, then some quality loss is possible during resulting document scaling.If Metafile is converted to Pdf vector graphics, then performance issues in Pdf viewing tool are possible.

      • setSaveMetafilesAsPng

        void setSaveMetafilesAsPng(boolean value)

        True to convert all metafiles used in a presentation to the PNG images. Read/write boolean.

        Default is <b>true</b>. Pdf document can contain vector graphics and raster images. If SaveMetafilesAsPng is set to true then source Metafile image is converted to Png format and saved to Pdf as a raster image. If SaveMetafilesAsPng is set to false then source Metafile is converted to Pdf vector graphics. Each approach has advantages and disadvantages.For example, if Metafile is converted to PNG, then some quality loss is possible during resulting document scaling.If Metafile is converted to Pdf vector graphics, then performance issues in Pdf viewing tool are possible.

      • getSufficientResolution

        float getSufficientResolution()

        Returns or sets a value determining resolution of images inside PDF document. Read/write float.

        Value: Effect of this parameter depends on few factors. Algorithm tries to get best output image size according to the property value, source image size and image frame size. Using of similar property values may give the same result. Recommended to use step 16 or 32 to get visible effect.

        <p>Property affects on file size, time of export and image quality.</p> <p>The default value is <b>96</b>.</p>

      • setSufficientResolution

        void setSufficientResolution(float value)

        Returns or sets a value determining resolution of images inside PDF document. Read/write float.

        Value: Effect of this parameter depends on few factors. Algorithm tries to get best output image size according to the property value, source image size and image frame size. Using of similar property values may give the same result. Recommended to use step 16 or 32 to get visible effect.

        <p>Property affects on file size, time of export and image quality.</p> <p>The default value is <b>96</b>.</p>

      • getDrawSlidesFrame

        boolean getDrawSlidesFrame()

        True to draw black frame around each slide. Read/write boolean.

        Default is <b>false</b>.

      • setDrawSlidesFrame

        void setDrawSlidesFrame(boolean value)

        True to draw black frame around each slide. Read/write boolean.

        Default is <b>false</b>.

      • getNotesCommentsLayouting

        INotesCommentsLayoutingOptions getNotesCommentsLayouting()

        Provides options that control how notes and comments is placed in exported document.

      • getImageTransparentColor

        java.lang.Integer getImageTransparentColor()

        Gets or sets the image transparent color.

        Value: The color of the image transparent.

      • setImageTransparentColor

        void setImageTransparentColor(java.lang.Integer value)

        Gets or sets the image transparent color.

        Value: The color of the image transparent.

      • getApplyImageTransparent

        boolean getApplyImageTransparent()

        Applies the specified transparent color to an image if true.

      • setApplyImageTransparent

        void setApplyImageTransparent(boolean value)

        Applies the specified transparent color to an image if true.