SignOptions Leave feedback
On this page
Inheritance: java.lang.Object
public abstract class SignOptions
Represents the signature options.
| Method | Description |
|---|---|
| getPageNumber() | Gets or sets document page number for signing. |
| setPageNumber(int value) | Gets or sets document page number for signing. |
| getAllPages() | Put signature on all document pages. |
| setAllPages(boolean value) | Put signature on all document pages. |
| getAppearance() | Additional signature appearance. |
| setAppearance(SignatureAppearance value) | Additional signature appearance. |
| getExtensions() | Signature Extensions. |
| setExtensions(List |
Signature Extensions. |
| getPagesSetup() | Options to specify pages to be signed. |
| setPagesSetup(PagesSetup value) | Options to specify pages to be signed. |
| getSignatureType() | Get the Signature Type SignatureType |
| getDocumentType() | Get or set the Document Type of the Signature Options DocumentType |
| setDocumentType(int value) | Get or set the Document Type of the Signature Options DocumentType |
| getZOrder() | Gets or sets the Z-order position of text signature. |
| setZOrder(int value) | Gets or sets the Z-order position of text signature. |
| getHashAlgorithm() | Gets or sets the hash algorithm to be used for cryptographic operations. |
| setHashAlgorithm(int value) | Gets or sets the hash algorithm to be used for cryptographic operations. |
| toString() | Override string conversion. |
| addSignature(Object[] args) |
public int getPageNumber()
Gets or sets document page number for signing. Minimal and default value is 1.
Returns: int
public void setPageNumber(int value)
Gets or sets document page number for signing. Minimal and default value is 1.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public boolean getAllPages()
Put signature on all document pages.
Returns: boolean
public void setAllPages(boolean value)
Put signature on all document pages.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final SignatureAppearance getAppearance()
Additional signature appearance.
Returns: SignatureAppearance
public final void setAppearance(SignatureAppearance value)
Additional signature appearance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | SignatureAppearance |
public final List<SignatureExtension> getExtensions()
Signature Extensions.
Returns: java.util.List<com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension>
public void setExtensions(List<SignatureExtension> value)
Signature Extensions.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.List<com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension> |
public PagesSetup getPagesSetup()
Options to specify pages to be signed.
Returns: PagesSetup
public void setPagesSetup(PagesSetup value)
Options to specify pages to be signed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PagesSetup |
public final int getSignatureType()
Get the Signature Type SignatureType
Returns: int
public final int getDocumentType()
Get or set the Document Type of the Signature Options DocumentType
Returns: int
public final void setDocumentType(int value)
Get or set the Document Type of the Signature Options DocumentType
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int getZOrder()
Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.
Returns: int
public final void setZOrder(int value)
Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int getHashAlgorithm()
Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files. Value is one of the constants on HashAlgorithm.
Returns: int
public final void setHashAlgorithm(int value)
Gets or sets the hash algorithm to be used for cryptographic operations. Supported exclusively for digital signatures in PDF files.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public String toString()
Override string conversion.
Returns: java.lang.String -
public BaseSignature addSignature(Object[] args)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| args | java.lang.Object[] |
Returns: BaseSignature
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.