com.groupdocs.redaction.options

Class SaveOptions

java.lang.Object

com.groupdocs.redaction.options.SaveOptions

public class SaveOptions
extends Object

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

Learn more

• Save with default options
• Save in rasterized PDF
• Select specific pages for rasterized PDF
• Save in original format
• Save overwriting original file
• Save to stream

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.

Method Summary

Modifier and Type	Method and Description
boolean	getAddSuffix() Gets a value indicating whether the file name needs to be changed before saving.
RasterizationOptions	getRasterization() Gets the rasterization settings.
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.
String	getRedactedFileSuffix() Gets a custom suffix for output file name.
WordprocessingSaveOptions	getWordprocessingSaveOptions() Word processing save options.
void	setAddSuffix(boolean value) Sets a value indicating whether the file name needs to be changed before saving.
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.
void	setRedactedFileSuffix(String value) Sets a custom suffix for output file name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

getRasterization

public final RasterizationOptions getRasterization()

Gets the rasterization settings.

Returns:

The rasterization settings.

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.

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.

getWordprocessingSaveOptions

public final WordprocessingSaveOptions getWordprocessingSaveOptions()

Word processing save options.

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.

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.

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.