SignOptions

Inheritance: java.lang.Object

public abstract class SignOptions

Represents the signature options.

Methods

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 value)	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)

getPageNumber()

public int getPageNumber()

Gets or sets document page number for signing. Minimal and default value is 1.

Returns: int

setPageNumber(int value)

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

getAllPages()

public boolean getAllPages()

Put signature on all document pages.

Returns: boolean

setAllPages(boolean value)

public void setAllPages(boolean value)

Put signature on all document pages.

Parameters:

Parameter	Type	Description
value	boolean

getAppearance()

public final SignatureAppearance getAppearance()

Additional signature appearance.

Returns: SignatureAppearance

setAppearance(SignatureAppearance value)

public final void setAppearance(SignatureAppearance value)

Additional signature appearance.

Parameters:

Parameter	Type	Description
value	SignatureAppearance

getExtensions()

public final List<SignatureExtension> getExtensions()

Signature Extensions.

Returns: java.util.List<com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension>

setExtensions(List value)

public void setExtensions(List<SignatureExtension> value)

Signature Extensions.

Parameters:

Parameter	Type	Description
value	java.util.List<com.groupdocs.signature.domain.extensions.signoptions.SignatureExtension>

getPagesSetup()

public PagesSetup getPagesSetup()

Options to specify pages to be signed.

Returns: PagesSetup

setPagesSetup(PagesSetup value)

public void setPagesSetup(PagesSetup value)

Options to specify pages to be signed.

Parameters:

Parameter	Type	Description
value	PagesSetup

getSignatureType()

public final int getSignatureType()

Get the Signature Type SignatureType

Returns: int

getDocumentType()

public final int getDocumentType()

Get or set the Document Type of the Signature Options DocumentType

Returns: int

setDocumentType(int value)

public final void setDocumentType(int value)

Get or set the Document Type of the Signature Options DocumentType

Parameters:

Parameter	Type	Description
value	int

getZOrder()

public final int getZOrder()

Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.

Returns: int

setZOrder(int value)

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

getHashAlgorithm()

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

setHashAlgorithm(int value)

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

toString()

public String toString()

Override string conversion.

Returns: java.lang.String -

addSignature(Object[] args)

public BaseSignature addSignature(Object[] args)

Parameters:

Parameter	Type	Description
args	java.lang.Object[]

Returns: BaseSignature