com.groupdocs.editor.options

Class PdfSaveOptions

  • All Implemented Interfaces:
    ISaveOptions


    public final class PdfSaveOptions
    extends Object
    implements ISaveOptions

    Allows to specify custom options for generating and saving PDF (Portable Document Format) documents

    • Constructor Summary

      Constructors 
      Constructor and Description
      PdfSaveOptions() 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int getCompliance()
      Specifies the PDF standards compliance level for output documents.
      boolean getEnablePagination()
      Allows to enable or disable pagination which will be used for saving the PDF document.
      byte getFontEmbedding()
      Responsible for embedding font resources into resultant PDf document, which are used in the WordProcessing document.
      String getPassword()
      Password, which will be applied to the generated PDF document as user password, required for opening.
      void setCompliance(int value)
      Specifies the PDF standards compliance level for output documents.
      void setEnablePagination(boolean value)
      Allows to enable or disable pagination which will be used for saving the PDF document.
      void setFontEmbedding(byte value)
      Responsible for embedding font resources into resultant PDf document, which are used in the WordProcessing document.
      void setPassword(String value)
      Password, which will be applied to the generated PDF document as user password, required for opening.
    • Constructor Detail

      • PdfSaveOptions

        public PdfSaveOptions()
    • Method Detail

      • getCompliance

        public final int getCompliance()

        Specifies the PDF standards compliance level for output documents. Default is PdfCompliance.Pdf15.

        Returns:
      • getEnablePagination

        public final boolean getEnablePagination()

        Allows to enable or disable pagination which will be used for saving the PDF document. The value of this option should match (be equal) the same option 'EnablePagination' in WordProcessingEditOptions class. By default is disabled.


        Input WordProcessing document can be opened and edited in float or paginal mode, which is controlled by the 'EnablePagination' flag in the WordProcessingEditOptions class. If the original document was opened and edited in pagination mode ('EnablePagination' was set to 'true'), this option also should be enabled (set to 'true'). And vice versa: if the original WordProcessing document was opened and edited in float mode, this flag should be set to 'false'.
        Returns:
      • getFontEmbedding

        public final byte getFontEmbedding()

        Responsible for embedding font resources into resultant PDf document, which are used in the WordProcessing document. By default doesn't embed any fonts (NotEmbed).

        Returns:
      • getPassword

        public final String getPassword()

        Password, which will be applied to the generated PDF document as user password, required for opening. If NULL or empty, no password will be applied to the document. Otherwise, document will be encrypted with RC4 (key length of 128 bit). By default is NULL — password is not applied.

        Returns:
      • setCompliance

        public final void setCompliance(int value)

        Specifies the PDF standards compliance level for output documents. Default is PdfCompliance.Pdf15.

        Parameters:
        value -
      • setEnablePagination

        public final void setEnablePagination(boolean value)

        Allows to enable or disable pagination which will be used for saving the PDF document. The value of this option should match (be equal) the same option 'EnablePagination' in WordProcessingEditOptions class. By default is disabled.


        Input WordProcessing document can be opened and edited in float or paginal mode, which is controlled by the 'EnablePagination' flag in the WordProcessingEditOptions class. If the original document was opened and edited in pagination mode ('EnablePagination' was set to 'true'), this option also should be enabled (set to 'true'). And vice versa: if the original WordProcessing document was opened and edited in float mode, this flag should be set to 'false'.
        Parameters:
        value -
      • setFontEmbedding

        public final void setFontEmbedding(byte value)

        Responsible for embedding font resources into resultant PDf document, which are used in the WordProcessing document. By default doesn't embed any fonts (NotEmbed).

        Parameters:
        value -
      • setPassword

        public final void setPassword(String value)

        Password, which will be applied to the generated PDF document as user password, required for opening. If NULL or empty, no password will be applied to the document. Otherwise, document will be encrypted with RC4 (key length of 128 bit). By default is NULL — password is not applied.

        Parameters:
        value -