com.groupdocs.editor.words.wordstohtml

Class WordToHtmlOptions

    • Constructor Summary

      Constructors 
      Constructor and Description
      WordToHtmlOptions()
      Creates and returns a new instance of the WordToHtmlOptions class, where all options are set to their default values
      WordToHtmlOptions(boolean enablePagination)
      Creates and returns a new instance of the WordToHtmlOptions class with specified pagination, default absent password and T:GroupDocs.Editor.Options.FontExtractionOptions is default
      WordToHtmlOptions(boolean enablePagination, byte option)
      Creates and returns a new instance of the WordToHtmlOptions class with specified pagination, default absent password and T:GroupDocs.Editor.Options.FontExtractionOptions
      WordToHtmlOptions(boolean enablePagination, String openingPassword)
      Creates and returns a new instance of the WordToHtmlOptions class with specified pagination, password and T:GroupDocs.Editor.Options.FontExtractionOptions is default
      WordToHtmlOptions(boolean enablePagination, String openingPassword, byte option)
      Creates and returns a new instance of the WordToHtmlOptions class with specified pagination, password and T:GroupDocs.Editor.Options.FontExtractionOptions
      WordToHtmlOptions(byte option)
      Creates and returns a new instance of the WordToHtmlOptions class with FontExtractionOptions
      WordToHtmlOptions(String openingPassword)
      Creates and returns a new instance of the WordToHtmlOptions class with specified password and T:GroupDocs.Editor.Options.FontExtractionOptions is default
      WordToHtmlOptions(String openingPassword, byte option)
      Creates and returns a new instance of the WordToHtmlOptions class with password and T:GroupDocs.Editor.Options.FontExtractionOptions
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean getEnablePagination()
      Allows to enable or disable pagination in the resultant HTML document.
      boolean getExportLanguageInformation()
      Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes.
      byte getExtractFontOption()
      Enables or disables ability to extract font resources, which are used in the input Words document.
      String getPassword()
      Allows to specify, modify and obtain the password, which will be used for opening Words document, if it is encoded.
      Boolean isValid() 
      void setEnablePagination(boolean value)
      Allows to enable or disable pagination in the resultant HTML document.
      void setExportLanguageInformation(boolean value)
      Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes.
      void setExtractFontOption(byte value)
      Enables or disables ability to extract font resources, which are used in the input Words document.
      void setPassword(String value)
      Allows to specify, modify and obtain the password, which will be used for opening Words document, if it is encoded.
    • Constructor Detail

      • WordToHtmlOptions

        public WordToHtmlOptions()

        Creates and returns a new instance of the WordToHtmlOptions class, where all options are set to their default values

      • WordToHtmlOptions

        public WordToHtmlOptions(boolean enablePagination)

        Creates and returns a new instance of the WordToHtmlOptions class with specified pagination, default absent password and T:GroupDocs.Editor.Options.FontExtractionOptions is default

        Parameters:
        enablePagination - Enable or disable pagination in the resultant HTML document.
      • WordToHtmlOptions

        public WordToHtmlOptions(boolean enablePagination,
                         byte option)

        Creates and returns a new instance of the WordToHtmlOptions class with specified pagination, default absent password and T:GroupDocs.Editor.Options.FontExtractionOptions

        Parameters:
        enablePagination - Enable or disable pagination in the resultant HTML document.
        option - <inheritdoc></inheritdoc>
      • WordToHtmlOptions

        public WordToHtmlOptions(boolean enablePagination,
                         String openingPassword)

        Creates and returns a new instance of the WordToHtmlOptions class with specified pagination, password and T:GroupDocs.Editor.Options.FontExtractionOptions is default

        Parameters:
        enablePagination - Enable or disable pagination in the resultant HTML document.
        openingPassword - The password, which will be used for opening Words document. <inheritdoc></inheritdoc>
      • WordToHtmlOptions

        public WordToHtmlOptions(boolean enablePagination,
                         String openingPassword,
                         byte option)

        Creates and returns a new instance of the WordToHtmlOptions class with specified pagination, password and T:GroupDocs.Editor.Options.FontExtractionOptions

        Parameters:
        enablePagination -
        openingPassword - The password, which will be used for opening Words document.
        option - <inheritdoc></inheritdoc>
      • WordToHtmlOptions

        public WordToHtmlOptions(byte option)

        Creates and returns a new instance of the WordToHtmlOptions class with FontExtractionOptions

        Parameters:
        option - Options, which defines font extraction policy
      • WordToHtmlOptions

        public WordToHtmlOptions(String openingPassword)

        Creates and returns a new instance of the WordToHtmlOptions class with specified password and T:GroupDocs.Editor.Options.FontExtractionOptions is default

        Parameters:
        openingPassword - Password, which will be applied for opening the document in case it is encrypted
      • WordToHtmlOptions

        public WordToHtmlOptions(String openingPassword,
                         byte option)

        Creates and returns a new instance of the WordToHtmlOptions class with password and T:GroupDocs.Editor.Options.FontExtractionOptions

        Parameters:
        openingPassword - Password, which will be applied for opening the document in case it is encrypted
        option - Options, which defines font extraction policy
    • Method Detail

      • getEnablePagination

        public boolean getEnablePagination()

        Allows to enable or disable pagination in the resultant HTML document.

        Returns:
      • getExportLanguageInformation

        public boolean getExportLanguageInformation()

        Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled (false).

      • getExtractFontOption

        public byte getExtractFontOption()

        Enables or disables ability to extract font resources, which are used in the input Words document. By default doesn't extract any fonts (NotExtract).

      • getPassword

        public String getPassword()

        Allows to specify, modify and obtain the password, which will be used for opening Words document, if it is encoded. Set to NULL or empty string in order to remove the password.

      • isValid

        public Boolean isValid()
      • setEnablePagination

        public void setEnablePagination(boolean value)

        Allows to enable or disable pagination in the resultant HTML document.

        Parameters:
        value -
      • setExportLanguageInformation

        public void setExportLanguageInformation(boolean value)

        Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled (false).

      • setExtractFontOption

        public void setExtractFontOption(byte value)

        Enables or disables ability to extract font resources, which are used in the input Words document. By default doesn't extract any fonts (NotExtract).

      • setPassword

        public void setPassword(String value)

        Allows to specify, modify and obtain the password, which will be used for opening Words document, if it is encoded. Set to NULL or empty string in order to remove the password.