com.groupdocs.redaction.options

Class SaveOptions


  • public class SaveOptions
extends Object

    Provides options for changing an output file name and/or converting the document to image-based PDF (rasterization).

    <b>Learn more</b>

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static String SaveSuffix
      Represents default suffix value, which is "Redacted".

    • Constructor Summary

      Constructors 
      Constructor and Description
      SaveOptions()
      Initializes a new instance with defaults: rasterize to PDF - false, add suffix - false.
      SaveOptions(boolean rasterizeToPdf, String suffix)
      Initializes a new instance with given parameters.

    • Field Detail

      • SaveSuffix

        public static final String SaveSuffix

        Represents default suffix value, which is "Redacted".

        See Also:
        Constant Field Values

    • Constructor Detail

      • SaveOptions

        public SaveOptions()

        Initializes a new instance with defaults: rasterize to PDF - false, add suffix - false.

      • SaveOptions

        public SaveOptions(boolean rasterizeToPdf,
           String suffix)

        Initializes a new instance with given parameters.

        Parameters:
        rasterizeToPdf - True, if all pages in the document need to be converted to images and put in a single PDF file
        suffix - This text will be added to the end of file name, if not empty also sets AddSuffix to true

    • Method Detail

      • getAddSuffix

        public final boolean getAddSuffix()

        Gets a value indicating whether the file name needs to be changed before saving. False by default.

        Returns:
        A value indicating whether the file name needs to be changed before saving. False by default.

      • setAddSuffix

        public final void setAddSuffix(boolean value)

        Sets a value indicating whether the file name needs to be changed before saving. False by default.

        Parameters:
        value - A value indicating whether the file name needs to be changed before saving. False by default.

      • getRedactedFileSuffix

        public final String getRedactedFileSuffix()

        Gets a custom suffix for output file name. If it is not specified, the SaveSuffix constant will be used.

        Returns:
        A custom suffix for output file name. If it is not specified, the SaveSuffix constant will be used.

      • setRedactedFileSuffix

        public final void setRedactedFileSuffix(String value)

        Sets a custom suffix for output file name. If it is not specified, the SaveSuffix constant will be used.

        Parameters:
        value - A custom suffix for output file name. If it is not specified, the SaveSuffix constant will be used.

      • getRasterizeToPDF

        public final boolean getRasterizeToPDF()

        Gets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file.

        Returns:
        A value indicating whether all pages in the document need to be converted to images and put in a single PDF file.

      • setRasterizeToPDF

        public final void setRasterizeToPDF(boolean value)

        Sets a value indicating whether all pages in the document need to be converted to images and put in a single PDF file.

        Parameters:
        value - A value indicating whether all pages in the document need to be converted to images and put in a single PDF file.

      • getRasterization

        public final RasterizationOptions getRasterization()

        Gets the rasterization settings.

        Returns:
        The rasterization settings.