PDFSignature Class Reference

Inheritance diagram for PDFSignature:

Public Member Functions
	getByteRange ()
	Get byte range which specifies scope of file stream of current signature. More...
	getFilter ()
	Get filter of current signature. More...
	getImage ()
	Get signature image. More...
	getPagingSealConfig ()
	Get the Paging seal config. More...
	getSignatureType ()
	Get the signature type. More...
	getSignInfo ()
	Get the signed signature information. More...
	getSubfilter ()
	Get subfilter of current signature. More...
	isLast ()
	Whether current signature is last one. More...
	isSigned ()
	Check if current signature is signed or not. More...
Public Member Functions inherited from PDFField
	getAlignment ()
	Get field's alignment. More...
	getAlternateName ()
	Get alternate name. More...
	getBorderColor ()
	Get field's border color. More...
	getBorderStyle ()
	Get field's border style. More...
	getControlByIndex (index)
	Get field's control by index. Please call PDFField.getControlsCount() to get count. More...
	getControlsCount ()
	Get the count of field's controls. More...
	getDAFontSize ()
	Get default appearance's font size. More...
	getFillColor ()
	Get field's fill color. More...
	getFlags ()
	Get field's flags. For more information, refer to Field_Flag. More...
	getMappingName ()
	Get mapping name. More...
	getMaxLength ()
	Get text field's max length. More...
	getName ()
	Get form field's name(aka title). More...
	getOptions ()
	Set combo box and list box's options. More...
	getType ()
	Get form field's type. More...
	getValue ()
	Get field value. More...
	setAction (trigger, action)
	Set field's action. More...
	setAlignment (alignment)
	Set field's alignment(Not support signature field). More...
	setAlternateName (alternateName)
	Set alternate name. More...
	setBorderColor (borderColor)
	Set field's border color(Not support signature field). More...
	setBorderStyle (strStyle)
	Set field's border style(Not support signature field). More...
	setFillColor (fillColor)
	Set field's fillColor(Not support signature field). More...
	setFlags (flags)
	Set field's flags. More...
	setMappingName (mappingName)
	Set mapping name. (Not support signature field). More...
	setMaxLength (maxLength)
	Set text field's max length. More...
	setOptions (options)
	Set options(items) of list box or combo box. More...
	setValue (value='', control=null)
	Set field's value. More...

Detailed Description

PDF Signature Field object

Since

7.4.0

Member Function Documentation

getByteRange()

PDFSignature::getByteRange ( )

inline

Get byte range which specifies scope of file stream of current signature.

Returns

number[] - A number array.

getFilter()

PDFSignature::getFilter ( )

inline

Get filter of current signature.

Returns

string - Filter of signature.

getImage()

PDFSignature::getImage ( )

inline

Get signature image.

Returns

Promise<string | void> - Return the string is in base64 format

Since

9.1.0

getPagingSealConfig()

PDFSignature::getPagingSealConfig ( )

inline

Get the Paging seal config.

Returns

Object|null - Return the paging seal config. Please refer to the parameter of PDFDoc.updatePagingSealInfo.

Example

function example(PDFSignature){
     const pagingSealConfig = PDFSignature.getPagingSealConfig()
}

Since

10.1.0

getSignatureType()

PDFSignature::getSignatureType ( )

inline

Get the signature type.

Returns

number - Return the signature type. Please refer to Signature_Type for more details.

Example

function example(PDFSignature){
   const signatureType = PDFSignature.getSignatureType()
}

Since

10.1.0

getSignInfo()

PDFSignature::getSignInfo ( )

inline

Get the signed signature information.

Returns

Record<string, any> - The signature info. Please refer to the parameter of PDFUI.registerSignaturePropertyHandler.

Note

If the signature field is not signed, an empty object is returned.

async function example(PDFSignature){
    await PDFSignature.getSignInfo()
}

See also

PDFDoc.sign

Since

9.0.0

getSubfilter()

PDFSignature::getSubfilter ( )

inline

Get subfilter of current signature.

Returns

string - Subfilter of signature.

isLast()

PDFSignature::isLast ( )

inline

Whether current signature is last one.

Returns

Promise<boolean>

Since

9.1.0

isSigned()

PDFSignature::isSigned ( )

inline

Check if current signature is signed or not.

Returns

boolean - True of false.