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>
Modifier and Type | Field and Description |
---|---|
static String |
SaveSuffix
Represents default suffix value, which is "Redacted".
|
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.
|
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.
|
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.
|
public static final String SaveSuffix
Represents default suffix value, which is "Redacted".
public SaveOptions()
Initializes a new instance with defaults: rasterize to PDF - false, add suffix - false.
public SaveOptions(boolean rasterizeToPdf, String suffix)
Initializes a new instance with given parameters.
rasterizeToPdf
- True, if all pages in the document need to be converted to images and put in a single PDF filesuffix
- This text will be added to the end of file name, if not empty also sets AddSuffix to truepublic final boolean getAddSuffix()
Gets a value indicating whether the file name needs to be changed before saving. False by default.
public final void setAddSuffix(boolean value)
Sets a value indicating whether the file name needs to be changed before saving. False by default.
value
- A value indicating whether the file name needs to be changed before saving. False by default.public final String getRedactedFileSuffix()
Gets a custom suffix for output file name. If it is not specified, the SaveSuffix
constant will be used.
SaveSuffix
constant will be used.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.
value
- A custom suffix for output file name. If it is not specified, the SaveSuffix
constant will be used.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.
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.
value
- A value indicating whether all pages in the document need to be converted to images and put in a single PDF file.public final RasterizationOptions getRasterization()
Gets the rasterization settings.