com.aspose.html.rendering.pdf

Class PdfRenderingOptions

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean getApplyImageTransparent()
      Applies the specified transparent color to an image if true.
      int getBookmarksOutlineLevel()
      Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on.
      int getCompliance()
      Desired conformance level for generated PDF document.
      PdfComplianceOptions getComplianceOptions()
      Represents Pdf compliance options.
      PdfDigitalSignatureDetailsCore getDigitalSignatureDetails()
      Gets or sets a digital signature details.
      PdfEncryptionInfo getEncryption()
      Gets or sets a encryption details.
      int getExpandedOutlineLevels()
      Specifies how many levels in the document outline to show expanded when the PDF file is viewed. 0 - the document outline is not expanded. 1 - first level items in the document are expanded and so on.
      int getFontEmbeddingRule()
      Gets or sets the font embedding rule.
      FontExceptionCollection getFontException()
      Gets the font embedding exception.
      int getHeadingsOutlineLevels()
      Specifies how many levels of ApsOutlineItem to include in the document outline. 0 - no outline, 1 - one outline level and so on.
      int getImageCompression()
      Specifies compression type to be used for all images in the document.
      com.aspose.ms.System.Drawing.Color getImageTransparentColor()
      Gets or sets the image transparent color.
      int getJpegQuality()
      Specifies the quality of JPEG compression for images (if JPEG compression is used).
      boolean getPdfaCompliant()
      Gets a value indicating whether [pdfa compliant].
      boolean getRenderMetafileAsBitmap()
      Gets or sets a value determining how metafile images should be rendered.
      long getTabSize()
      The tab-size property is used to customize the width of a tab (U+0009) character.
      int getTextCompression()
      Specifies compression type to be used for all content streams except images.
      boolean isEncrypted()
      Returns true if document encryption option is on.
      boolean isShowHyperlinkRects()
      A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.
      void setApplyImageTransparent(boolean value)
      Applies the specified transparent color to an image if true.
      void setBookmarksOutlineLevel(int value)
      Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on.
      void setCompliance(int value)
      Desired conformance level for generated PDF document.
      void setComplianceOptions(PdfComplianceOptions value)
      Represents Pdf compliance options.
      void setDigitalSignatureDetails(PdfDigitalSignatureDetailsCore value)
      Gets or sets a digital signature details.
      void setEncryption(PdfEncryptionInfo value)
      Gets or sets a encryption details.
      void setExpandedOutlineLevels(int value)
      Specifies how many levels in the document outline to show expanded when the PDF file is viewed. 0 - the document outline is not expanded. 1 - first level items in the document are expanded and so on.
      void setFontEmbeddingRule(int value)
      Gets or sets the font embedding rule.
      void setHeadingsOutlineLevels(int value)
      Specifies how many levels of ApsOutlineItem to include in the document outline. 0 - no outline, 1 - one outline level and so on.
      void setImageCompression(int value)
      Specifies compression type to be used for all images in the document.
      void setImageTransparentColor(com.aspose.ms.System.Drawing.Color value)
      Gets or sets the image transparent color.
      void setJpegQuality(int value)
      Specifies the quality of JPEG compression for images (if JPEG compression is used).
      void setRenderMetafileAsBitmap(boolean value)
      Gets or sets a value determining how metafile images should be rendered.
      void setShowHyperlinkRects(boolean value)
      A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.
      void setTabSize(long value)
      The tab-size property is used to customize the width of a tab (U+0009) character.
      void setTextCompression(int value)
      Specifies compression type to be used for all content streams except images.
      void validate()
      Validates that the requested options are compatible with each other and throws an exception with an explanatory message if needed.
    • Constructor Detail

      • PdfRenderingOptions

        public PdfRenderingOptions()
    • Method Detail

      • validate

        public void validate()

        Validates that the requested options are compatible with each other and throws an exception with an explanatory message if needed.

      • getHeadingsOutlineLevels

        public int getHeadingsOutlineLevels()

        Specifies how many levels of ApsOutlineItem to include in the document outline. 0 - no outline, 1 - one outline level and so on. Default is 0.

      • setHeadingsOutlineLevels

        public void setHeadingsOutlineLevels(int value)

        Specifies how many levels of ApsOutlineItem to include in the document outline. 0 - no outline, 1 - one outline level and so on. Default is 0.

      • getExpandedOutlineLevels

        public int getExpandedOutlineLevels()

        Specifies how many levels in the document outline to show expanded when the PDF file is viewed. 0 - the document outline is not expanded. 1 - first level items in the document are expanded and so on. Default is 0.

      • setExpandedOutlineLevels

        public void setExpandedOutlineLevels(int value)

        Specifies how many levels in the document outline to show expanded when the PDF file is viewed. 0 - the document outline is not expanded. 1 - first level items in the document are expanded and so on. Default is 0.

      • getBookmarksOutlineLevel

        public int getBookmarksOutlineLevel()

        Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0.

      • setBookmarksOutlineLevel

        public void setBookmarksOutlineLevel(int value)

        Specifies at which level in the document outline to display ApsBookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0.

      • getTextCompression

        public int getTextCompression()

        Specifies compression type to be used for all content streams except images. Default is PdfTextCompressionCore.Flate.

      • setTextCompression

        public void setTextCompression(int value)

        Specifies compression type to be used for all content streams except images. Default is PdfTextCompressionCore.Flate.

      • getImageCompression

        public int getImageCompression()

        Specifies compression type to be used for all images in the document. Default is PdfImageCompressionCore.Auto.

      • setImageCompression

        public void setImageCompression(int value)

        Specifies compression type to be used for all images in the document. Default is PdfImageCompressionCore.Auto.

      • getJpegQuality

        public int getJpegQuality()

        Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.

      • setJpegQuality

        public void setJpegQuality(int value)

        Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.

      • isShowHyperlinkRects

        public boolean isShowHyperlinkRects()

        A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.

      • setShowHyperlinkRects

        public void setShowHyperlinkRects(boolean value)

        A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.

      • getCompliance

        public int getCompliance()

        Desired conformance level for generated PDF document. Important note: This option should not be changed after PdfDocument object is constructed. Default is PdfComplianceCore.Pdf15.

      • setCompliance

        public void setCompliance(int value)

        Desired conformance level for generated PDF document. Important note: This option should not be changed after PdfDocument object is constructed. Default is PdfComplianceCore.Pdf15.

      • getComplianceOptions

        public PdfComplianceOptions getComplianceOptions()

        Represents Pdf compliance options.

      • setComplianceOptions

        public void setComplianceOptions(PdfComplianceOptions value)

        Represents Pdf compliance options.

      • getPdfaCompliant

        public boolean getPdfaCompliant()

        Gets a value indicating whether [pdfa compliant].

        Value: true if [pdfa compliant]; otherwise, false.
      • getEncryption

        public PdfEncryptionInfo getEncryption()

        Gets or sets a encryption details. If not set, then no encryption will be performed.

      • setEncryption

        public void setEncryption(PdfEncryptionInfo value)

        Gets or sets a encryption details. If not set, then no encryption will be performed.

      • isEncrypted

        public boolean isEncrypted()

        Returns true if document encryption option is on.

      • getImageTransparentColor

        public com.aspose.ms.System.Drawing.Color getImageTransparentColor()

        Gets or sets the image transparent color.

        Value: The color of the image transparent.
      • setImageTransparentColor

        public void setImageTransparentColor(com.aspose.ms.System.Drawing.Color value)

        Gets or sets the image transparent color.

        Value: The color of the image transparent.
      • getApplyImageTransparent

        public boolean getApplyImageTransparent()

        Applies the specified transparent color to an image if true.

      • setApplyImageTransparent

        public void setApplyImageTransparent(boolean value)

        Applies the specified transparent color to an image if true.

      • getDigitalSignatureDetails

        public PdfDigitalSignatureDetailsCore getDigitalSignatureDetails()

        Gets or sets a digital signature details. If not set, then no signing will be performed.

      • setDigitalSignatureDetails

        public void setDigitalSignatureDetails(PdfDigitalSignatureDetailsCore value)

        Gets or sets a digital signature details. If not set, then no signing will be performed.

      • getRenderMetafileAsBitmap

        public boolean getRenderMetafileAsBitmap()

        Gets or sets a value determining how metafile images should be rendered.

      • setRenderMetafileAsBitmap

        public void setRenderMetafileAsBitmap(boolean value)

        Gets or sets a value determining how metafile images should be rendered.

      • getFontException

        public FontExceptionCollection getFontException()

        Gets the font embedding exception.

      • getFontEmbeddingRule

        public int getFontEmbeddingRule()

        Gets or sets the font embedding rule.

        Value: The font embedding rule.
      • setFontEmbeddingRule

        public void setFontEmbeddingRule(int value)

        Gets or sets the font embedding rule.

        Value: The font embedding rule.
      • getTabSize

        public long getTabSize()

        The tab-size property is used to customize the width of a tab (U+0009) character.

        Value: The size of the tab.
      • setTabSize

        public void setTabSize(long value)

        The tab-size property is used to customize the width of a tab (U+0009) character.

        Value: The size of the tab.