SigBackgroundImageType Property

The type of the image contained in BackgroundData .

Syntax

 pdfsigner.getSigBackgroundImageType([callback])
 pdfsigner.setSigBackgroundImageType( sigBackgroundImageType, [callback])

Possible Values

  0 (pwitJPEG2000), 
  1 (pwitJPEG), 
  2 (pwitCustom)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSigBackgroundImageType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSigBackgroundImageType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The type of the image contained in SigBackgroundData. JPEG and JPEG2000 format are currently supported.

This property is not available at design time.

Data Type

Integer