PdfSaveOptions
Inheritance: java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions
public class PdfSaveOptions extends SaveOptions
Save options for PDF documents.
Constructors
| Constructor | Description |
|---|---|
| PdfSaveOptions() | Initializes a new instance of PdfSaveOptions class with default values. |
| PdfSaveOptions(int fileFormat) | Initializes a new instance of PdfSaveOptions class with specified output file format. |
| PdfSaveOptions(boolean overwriteExistingFile) | Initializes a new instance of PdfSaveOptions class with overwrite flag. |
| PdfSaveOptions(int fileFormat, boolean overwriteExistingFile) | Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag. |
Methods
| Method | Description |
|---|---|
| getFileFormat() | Gets or sets file format of signed document. |
| setFileFormat(int value) | Gets or sets file format of signed document. |
| getPermissionsPassword() | A permissions password (the primary password) requires a password to change permission settings. |
| setPermissionsPassword(String value) | A permissions password (the primary password) requires a password to change permission settings. |
| getPermissions() | The PDF document permissions such as printing, modification and data extraction. |
| setPermissions(Integer value) | The PDF document permissions such as printing, modification and data extraction. |
| toString() | Override string conversion. |
PdfSaveOptions()
public PdfSaveOptions()
Initializes a new instance of PdfSaveOptions class with default values.
PdfSaveOptions(int fileFormat)
public PdfSaveOptions(int fileFormat)
Initializes a new instance of PdfSaveOptions class with specified output file format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileFormat | int | Output file type PdfSaveFileFormat. |
PdfSaveOptions(boolean overwriteExistingFile)
public PdfSaveOptions(boolean overwriteExistingFile)
Initializes a new instance of PdfSaveOptions class with overwrite flag.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |
PdfSaveOptions(int fileFormat, boolean overwriteExistingFile)
public PdfSaveOptions(int fileFormat, boolean overwriteExistingFile)
Initializes a new instance of PdfSaveOptions class with specified output file format and overwrite flag.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileFormat | int | Output file type PdfSaveFileFormat. |
| overwriteExistingFile | boolean | Flag whether to overwrite signed file with same file. |
getFileFormat()
public final int getFileFormat()
Gets or sets file format of signed document.
Returns: int
setFileFormat(int value)
public final void setFileFormat(int value)
Gets or sets file format of signed document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getPermissionsPassword()
public final String getPermissionsPassword()
A permissions password (the primary password) requires a password to change permission settings.
Returns: java.lang.String
setPermissionsPassword(String value)
public final void setPermissionsPassword(String value)
A permissions password (the primary password) requires a password to change permission settings.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getPermissions()
public final Integer getPermissions()
The PDF document permissions such as printing, modification and data extraction.
To modify these permissions, the PermissionsPassword must be set. The value is a flags combination from Permissions. A null value means no explicit permissions are applied.
Returns: java.lang.Integer
setPermissions(Integer value)
public final void setPermissions(Integer value)
The PDF document permissions such as printing, modification and data extraction.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Integer |
toString()
public String toString()
Override string conversion.
Returns: java.lang.String -