SaveOptions
Inheritance: java.lang.Object
public class SaveOptions
Allows to specify additional options (such as password) when saving a document to sign.
Constructors
| Constructor | 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. |
Methods
| Method | Description |
|---|---|
| getOverwriteExistingFiles() | Gets or sets whether to overwrite existing file with new output file. |
| setOverwriteExistingFiles(boolean value) | Gets or sets whether to overwrite existing file with new output file. |
| getPassword() | Gets or sets password to save signed document with password protection. |
| setPassword(String value) | Gets or sets password to save signed document with password protection. |
| getUseOriginalPassword() | Gets or sets whether to use password from LoadOptions to save signed document as protected. |
| setUseOriginalPassword(boolean value) | Gets or sets whether to use password from LoadOptions to save signed document as protected. |
| getAddMissingExtenstion() | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
| setAddMissingExtenstion(boolean value) | Gets or sets flag to automatically add extension when it was missing in output file path Default value is false. |
SaveOptions()
public SaveOptions()
Initializes a new instance of SaveOptions class with default values.
SaveOptions(boolean overwriteExistingFile)
public SaveOptions(boolean overwriteExistingFile)
Initializes a new instance of SaveOptions class with specified output type and overwrite flag.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |
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.
Returns: boolean
setOverwriteExistingFiles(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getPassword()
public final String getPassword()
Gets or sets password to save signed document with password protection. This property is not supported for Image documents.
Returns: java.lang.String
setPassword(String value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
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.
Returns: boolean
setUseOriginalPassword(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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.
Returns: boolean
setAddMissingExtenstion(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |