com.groupdocs.signature.options.saveoptions

Class SaveOptions

java.lang.Object

com.groupdocs.signature.options.saveoptions.SaveOptions

Direct Known Subclasses:

com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions, PdfSaveOptions, PresentationSaveOptions, SpreadsheetSaveOptions, WordProcessingSaveOptions

public class SaveOptions
extends Object

Allows to specify additional options (such as password) when saving a document to sign.

Constructor Summary

Constructors

Constructor and Description
SaveOptions() Initializes a new instance of SaveOptions class with default values.
SaveOptions(boolean overwriteExistingFile) Initializes a new instance of SaveOptions class with specified output type and overwrite flag.

Method Summary

Modifier and Type	Method and Description
boolean	getAddMissingExtenstion() Gets or sets flag to automatically add extension when it was missing in output file path Default value is false.
boolean	getOverwriteExistingFiles() Gets or sets whether to overwrite existing file with new output file.
String	getPassword() Gets or sets password to save signed document with password protection.
boolean	getUseOriginalPassword() Gets or sets whether to use password from LoadOptions to save signed document as protected.
void	setAddMissingExtenstion(boolean value) Gets or sets flag to automatically add extension when it was missing in output file path Default value is false.
void	setOverwriteExistingFiles(boolean value) Gets or sets whether to overwrite existing file with new output file.
void	setPassword(String value) Gets or sets password to save signed document with password protection.
void	setUseOriginalPassword(boolean value) Gets or sets whether to use password from LoadOptions to save signed document as protected.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveOptions

public SaveOptions()

Initializes a new instance of SaveOptions class with default values.

SaveOptions

public SaveOptions(boolean overwriteExistingFile)

Initializes a new instance of SaveOptions class with specified output type and overwrite flag.

Parameters:

overwriteExistingFile - Flag whether to overwrite signed file with same file.

Method Detail

getAddMissingExtenstion

public final boolean getAddMissingExtenstion()

Gets or sets flag to automatically add extension when it was missing in output file path Default value is false.

getOverwriteExistingFiles

public final boolean getOverwriteExistingFiles()

Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix.

getPassword

public final String getPassword()

Gets or sets password to save signed document with password protection. This property is not supported for Image documents.

getUseOriginalPassword

public final boolean getUseOriginalPassword()

Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents.

setAddMissingExtenstion

public final void setAddMissingExtenstion(boolean value)

Gets or sets flag to automatically add extension when it was missing in output file path Default value is false.

setOverwriteExistingFiles

public final void setOverwriteExistingFiles(boolean value)

Gets or sets whether to overwrite existing file with new output file. Otherwise new file will be created with number as suffix.

setPassword

public final void setPassword(String value)

Gets or sets password to save signed document with password protection. This property is not supported for Image documents.

setUseOriginalPassword

public final void setUseOriginalPassword(boolean value)

Gets or sets whether to use password from LoadOptions to save signed document as protected. Default value is true. This property is not supported for Image documents.